{ "info": { "_postman_id": "340ff45d-8cb6-46ca-8eec-03e3d9dfa2e8", "name": "Fivetran REST API", "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)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "25936420" }, "item": [ { "name": "public", "item": [ { "name": "connector-types", "item": [ { "name": "Retrieve Source Metadata Public Endpoint", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/public/connector-types", "host": [ "{{baseUrl}}" ], "path": [ "public", "connector-types" ] }, "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." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/public/connector-types", "host": [ "{{baseUrl}}" ], "path": [ "public", "connector-types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"google_ads\",\n \"name\": \"Google Ads\",\n \"type\": \"Marketing\",\n \"description\": \"Google Ads is an online advertising platform\",\n \"icons\": [\n \"string\",\n \"string\"\n ],\n \"config\": {},\n \"auth\": {},\n \"icon_url\": \"https://fivetran.com/integrations/google_ads/resources/google-ads.png\",\n \"link_to_docs\": \"https://fivetran.com/docs/connectors/applications/google-ads\",\n \"connector_class\": \"lite\",\n \"supported_features\": [\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n },\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n }\n ],\n \"link_to_erd\": \"https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed\",\n \"service_status\": \"general_availability\",\n \"service_status_updated_at\": \"1991-09-14T18:43:58.395Z\",\n \"external_secrets_keys_config\": {}\n },\n \"message\": \"Connector metadata retrieved successfully\"\n}" } ] } ] } ] }, { "name": "v1", "item": [ { "name": "account", "item": [ { "name": "info", "item": [ { "name": "Get Account Info from the API Key", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/account/info", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "info" ] }, "description": "Returns information about current account from API key." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/account/info", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"account_id\": \"account_id\",\n \"account_name\": \"string\",\n \"user_id\": \"user_id\",\n \"system_key_id\": \"system_key_id\"\n },\n \"message\": \"Account information retrieved successfully\"\n}" }, { "name": "Invalid authorization credentials", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/account/info", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "connections", "item": [ { "name": "{connectionId}", "item": [ { "name": "certificates", "item": [ { "name": "{hash}", "item": [ { "name": "Retrieve Connection Certificate Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] }, "description": "Returns details of the certificate approved for the specified connection with specified certificate hash." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n },\n \"message\": \"Connection certificate details retrieved successfully\"\n}" }, { "name": "Certificate with specified hash not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Revoke Connection Certificate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] }, "description": "Revokes a certificate, so Fivetran no longer trusts it while connecting to the source database." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Certificate 'string' has been revoked for connection 'string'\"\n}" }, { "name": "Certificate with specified hash not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List Certificates Approved for the Connection", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns the list of approved certificates for the specified connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n },\n {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Connection certificates retrieved successfully\"\n}" }, { "name": "Connection not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Approve a Certificate for the Connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n },\n \"message\": \"The certificate has been approved.\"\n}" }, { "name": "Missing `hash` or `encoded_cert` fields in request payload", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Connection not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "certificates" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "connect-card", "item": [ { "name": "Create a Connect Card", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Generates the Connect Card URI for the connection" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"connector_id\": \"connection_id\",\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n },\n \"message\": \"Connection Connect Card has been created\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/connect-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "connect-card" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "fingerprints", "item": [ { "name": "{hash}", "item": [ { "name": "Retrieve Connection Fingerprint Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] }, "description": "Returns SSH fingerprint details approved for specified connection with specified hash" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n },\n \"message\": \"Connection fingerprint details retrieved successfully\"\n}" }, { "name": "Fingerprint with specified hash not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Revoke Connection Fingerprint", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] }, "description": "Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the source database through an SSH tunnel." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Fingerprint with hash 'string' has been revoked for connection with id 'string'\"\n}" }, { "name": "Fingerprint with specified hash not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints", ":hash" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List Fingerprints Approved for the Connection", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns the list of approved SSH fingerprints for specified connection" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n },\n {\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Connection fingerprints retrieved successfully\"\n}" }, { "name": "Connection not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Approve a Fingerprint for the Connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Approves a fingerprint, enabling Fivetran to trust it for a source database and establish connections via an SSH tunnel." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n}" }, { "name": "Missing `hash` or `public_key` fields in request payload", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Connection not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "fingerprints" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "move", "item": [ { "name": "Move a Connection (Beta)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"connection_id\": \"connection_id\",\n \"destination_group_id\": \"destination_group_id\",\n \"moved_at\": \"2024-01-01T00:00:00Z\",\n \"source_group_id\": \"source_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n },\n \"message\": \"Connection moved successfully\"\n}" }, { "name": "Bad request error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"destination_group_id\": \"destination_group_id\",\n \"sync_behavior\": \"CONTINUE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/move", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "move" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "resync", "item": [ { "name": "Re-sync Connection Data (Historical Sync)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Sync has been successfully triggered for connection with id 'string'\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Conflict error. Returned when a data sync is already in progress and cannot be completed before the re-sync can be scheduled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "schemas", "item": [ { "name": "drop-columns", "item": [ { "name": "Drop Blocked Columns from the Destination.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema\": {\n \"tables\": {\n \"table\": {\n \"columns\": [\n \"string\",\n \"string\"\n ]\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/drop-columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "drop-columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Mark multiple blocked columns for deletion from your destination tables. The columns will be dropped during the next sync." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema\": {\n \"tables\": {\n \"table\": {\n \"columns\": [\n \"string\",\n \"string\"\n ]\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/drop-columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "drop-columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Column(s) successfully marked for deletion\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema\": {\n \"tables\": {\n \"table\": {\n \"columns\": [\n \"string\",\n \"string\"\n ]\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/drop-columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "drop-columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema\": {\n \"tables\": {\n \"table\": {\n \"columns\": [\n \"string\",\n \"string\"\n ]\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/drop-columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "drop-columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Column not in blocked state error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema\": {\n \"tables\": {\n \"table\": {\n \"columns\": [\n \"string\",\n \"string\"\n ]\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/drop-columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "drop-columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reload", "item": [ { "name": "Reload a Connection Schema Config", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"exclude_mode\": \"PRESERVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/reload", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "reload" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"exclude_mode\": \"PRESERVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/reload", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "reload" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Schema configuration has been reloaded\"\n}" } ] } ] }, { "name": "tables", "item": [ { "name": "resync", "item": [ { "name": "Re-sync Connection Table Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/tables/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "tables", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schema\": [\n \"table1\",\n \"table2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/tables/resync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", "tables", "resync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Re-sync has been triggered successfully\"\n}" } ] } ] } ] }, { "name": "{schemaName}", "item": [ { "name": "tables", "item": [ { "name": "{tableName}", "item": [ { "name": "columns", "item": [ { "name": "{columnName}", "item": [ { "name": "Drop a Blocked Column From the Destination", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Column successfully marked for deletion\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Column not in blocked state error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Connection Column Config", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName/columns/:columnName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName", "columns", ":columnName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." }, { "key": "columnName", "value": "columnName", "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." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Column configuration has been modified\"\n}" } ] } ] } ] }, { "name": "Update a Connection Table Config", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"columns\": {\n \"key_0\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n },\n \"key_1\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n }\n },\n \"sync_mode\": \"SOFT_DELETE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"columns\": {\n \"key_0\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n },\n \"key_1\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n }\n },\n \"sync_mode\": \"SOFT_DELETE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName/tables/:tableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName", "tables", ":tableName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." }, { "key": "tableName", "value": "tableName", "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." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Table configuration has been modified\"\n}" } ] } ] } ] }, { "name": "Update a Connection Database Schema Config", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"tables\": {\n \"key_0\": {\n \"enabled\": true,\n \"columns\": {\n \"key_0\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n },\n \"key_1\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n },\n \"key_2\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n },\n \"key_3\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"tables\": {\n \"key_0\": {\n \"enabled\": true,\n \"columns\": {\n \"key_0\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n },\n \"key_1\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n },\n \"key_2\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n },\n \"key_3\": {\n \"enabled\": true,\n \"hashed\": false,\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schemaName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schemaName" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schemaName", "value": "schemaName", "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." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Database schema configuration has been modified\"\n}" } ] } ] }, { "name": "{schema}", "item": [ { "name": "tables", "item": [ { "name": "{table}", "item": [ { "name": "columns", "item": [ { "name": "Retrieve Source Table Columns Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schema/tables/:table/columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schema", "tables", ":table", "columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schema", "value": "schema", "description": "The database schema name within your destination" }, { "key": "table", "value": "table", "description": "The table name from the connection schema, using the original source system's naming conventions. This value is case-sensitive." } ] }, "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\n> NOTE: This endpoint works only for an existing connection that is in a 'Connected' state.\n" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas/:schema/tables/:table/columns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas", ":schema", "tables", ":table", "columns" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." }, { "key": "schema", "value": "schema", "description": "The database schema name within your destination" }, { "key": "table", "value": "table", "description": "The table name from the connection schema, using the original source system's naming conventions. This value is case-sensitive." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": false,\n \"target_data_type\": \"String\"\n }\n }\n },\n \"message\": \"Column configuration retrieved successfully\"\n}" } ] } ] } ] } ] } ] }, { "name": "Retrieve a Connection Schema Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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 real-time, exhaustive column list for a specific table, call the [Retrieve Source Table Columns Config](/docs/rest-api/api-reference/connection-schema/connection-column-config) endpoint. \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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Schema configuration retrieved successfully\"\n}" } ] }, { "name": "Set Up a New Connection Schema Config", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema_name\": {\n \"enabled\": true,\n \"tables\": {\n \"table_name\": {\n \"enabled\": true,\n \"sync_mode\": \"SOFT_DELETE\",\n \"columns\": {\n \"column_name\": {\n \"enabled\": true,\n \"hashed\": false\n }\n }\n }\n }\n }\n },\n \"schema_change_handling\": \"ALLOW_COLUMNS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema_name\": {\n \"enabled\": true,\n \"tables\": {\n \"table_name\": {\n \"enabled\": true,\n \"sync_mode\": \"SOFT_DELETE\",\n \"columns\": {\n \"column_name\": {\n \"enabled\": true,\n \"hashed\": false\n }\n }\n }\n }\n }\n },\n \"schema_change_handling\": \"ALLOW_COLUMNS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Schema configuration pre-created successfully\"\n}" } ] }, { "name": "Update a Connection Schema Config", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema_name\": {\n \"enabled\": true,\n \"tables\": {\n \"table_name\": {\n \"enabled\": true,\n \"sync_mode\": \"SOFT_DELETE\",\n \"columns\": {\n \"column_name\": {\n \"enabled\": true,\n \"hashed\": false\n }\n }\n }\n }\n }\n },\n \"schema_change_handling\": \"BLOCK_ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schemas\": {\n \"schema_name\": {\n \"enabled\": true,\n \"tables\": {\n \"table_name\": {\n \"enabled\": true,\n \"sync_mode\": \"SOFT_DELETE\",\n \"columns\": {\n \"column_name\": {\n \"enabled\": true,\n \"hashed\": false\n }\n }\n }\n }\n }\n },\n \"schema_change_handling\": \"BLOCK_ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/schemas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "schemas" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"schema_change_handling\": \"ALLOW_ALL\",\n \"schemas\": {\n \"schema\": {\n \"enabled\": true,\n \"name_in_destination\": \"schema_name_in_destination\",\n \"tables\": {\n \"table\": {\n \"columns\": {\n \"column\": {\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_COLUMN\"\n },\n \"hashed\": false,\n \"name_in_destination\": \"column_name_in_destination\",\n \"is_primary_key\": true,\n \"target_data_type\": \"String\"\n }\n },\n \"enabled\": true,\n \"enabled_patch_settings\": {\n \"allowed\": false,\n \"reason\": \"...\",\n \"reason_code\": \"SYSTEM_TABLE\"\n },\n \"name_in_destination\": \"table_name_in_destination\",\n \"supports_columns_config\": true,\n \"supports_history_mode\": true,\n \"sync_mode\": \"SOFT_DELETE\"\n }\n }\n }\n },\n \"enable_new_by_default\": true\n },\n \"message\": \"Schema configuration has been modified\"\n}" } ] } ] }, { "name": "state", "item": [ { "name": "Retrieve Connection State", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns the connection state. This endpoint is only supported for Function and Connection SDK connectors. To update the connection state, use [Update Connection State](https://fivetran.com/docs/rest-api/api-reference/connections/modify-connection-state)." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n },\n \"message\": \"Connection state retrieved successfully\"\n}" }, { "name": "The specified connection does not support state management. Only Function and Connector SDK connectors support this operation.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Connection not found error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Connection State", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Updates the connection state. 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](https://fivetran.com/docs/rest-api/api-reference/connections/modify-connection) endpoint (set 'paused' to 'true').\n 2. Update the state by using the [Update Connection State](https://fivetran.com/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](https://fivetran.com/docs/rest-api/api-reference/connections/modify-connection) endpoint request.\n\nThis endpoint is only supported for [Function](https://fivetran.com/docs/connectors/functions) and [Connection SDK](https://fivetran.com/docs/connectors/connector-sdk) connectors.\n" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n },\n \"message\": \"Connection state has been updated\"\n}" }, { "name": "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.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Connection not found error.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Connection cannot be updated because the sync is in progress.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"state\": {\n \"cursor\": \"2024-01-01T00:00:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/state", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "state" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sync", "item": [ { "name": "Sync Connection Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Sync has been successfully triggered for connection with id 'string'\"\n}" }, { "name": "Unauthorized error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sync-history", "item": [ { "name": "Retrieve Connection Sync History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "query": [ { "key": "start_time", "value": "string", "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." }, { "key": "end_time", "value": "string", "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`." }, { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns a list of sync history records for the specified connection. The maximum time window is 7 days." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "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.", "key": "start_time", "value": "string" }, { "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`.", "key": "end_time", "value": "string" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"stages\": {\n \"extract\": {\n \"volume\": 4627.85596622446\n },\n \"process\": {\n \"volume\": 2534.8020414934626\n },\n \"load\": {\n \"volume\": 5692.76260394441\n }\n },\n \"status\": \"string\",\n \"sync_id\": \"string\",\n \"start\": \"string\",\n \"end\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"stages\": {\n \"extract\": {\n \"volume\": 6802.326916454831\n },\n \"process\": {\n \"volume\": 5260.91098919984\n },\n \"load\": {\n \"volume\": 5206.185454488458\n }\n },\n \"status\": \"string\",\n \"sync_id\": \"string\",\n \"start\": \"string\",\n \"end\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Operation performed successfully\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "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.", "key": "start_time", "value": "string" }, { "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`.", "key": "end_time", "value": "string" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "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.", "key": "start_time", "value": "string" }, { "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`.", "key": "end_time", "value": "string" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "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.", "key": "start_time", "value": "string" }, { "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`.", "key": "end_time", "value": "string" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "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.", "key": "start_time", "value": "string" }, { "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`.", "key": "end_time", "value": "string" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/sync-history?start_time=string&end_time=string&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "sync-history" ], "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.", "key": "start_time", "value": "string" }, { "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`.", "key": "end_time", "value": "string" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "test", "item": [ { "name": "Run Connection Setup Tests", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"data_delay_sensitivity\": \"NORMAL\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"schema.table\",\n \"service\": \"google_ads\",\n \"service_version\": 0,\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 1440,\n \"connected_by\": \"priceless_odour\",\n \"succeeded_at\": \"2024-03-17T12:31:40.870504Z\",\n \"failed_at\": \"2024-04-01T18:13:25.043659Z\",\n \"data_delay_threshold\": 0,\n \"private_link_id\": \"link_id\",\n \"networking_method\": \"Directly\",\n \"proxy_agent_id\": \"agent_id\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"source_sync_details\": {},\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"hybrid_deployment_agent_id\": \"agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n },\n \"message\": \"Setup tests have been completed\"\n}" }, { "name": "Bad request error. Returned when the request body is omitted entirely (as opposed to an empty object, which is accepted).", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId", "test" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve Connection Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns a connection configuration and status details if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"data_delay_sensitivity\": \"NORMAL\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"schema.table\",\n \"service\": \"google_ads\",\n \"service_version\": 0,\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 5,\n \"connected_by\": \"priceless_odour\",\n \"succeeded_at\": \"2024-03-17T12:31:40.870504Z\",\n \"failed_at\": \"2024-04-01T18:13:25.043659Z\",\n \"data_delay_threshold\": 0,\n \"private_link_id\": \"link_id\",\n \"networking_method\": \"Unknown\",\n \"proxy_agent_id\": \"agent_id\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"source_sync_details\": {},\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"hybrid_deployment_agent_id\": \"agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n },\n \"message\": \"Connection details retrieved successfully\"\n}" }, { "name": "Unauthorized error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a Connection", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Deletes a connection from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Connection with id 'string' has been deleted\"\n}" }, { "name": "Not found error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Connection", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"auth\": \"\",\n \"paused\": false,\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"sync_frequency\": 30,\n \"data_delay_threshold\": 7512,\n \"data_delay_sensitivity\": \"CUSTOM\",\n \"daily_sync_time\": \"14:00\",\n \"pause_after_trial\": false,\n \"schema_status\": \"ready\",\n \"is_historical_sync\": true,\n \"schedule_type\": \"auto\",\n \"run_setup_tests\": true,\n \"networking_method\": \"Directly\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"auth\": \"\",\n \"paused\": false,\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"sync_frequency\": 30,\n \"data_delay_threshold\": 7512,\n \"data_delay_sensitivity\": \"CUSTOM\",\n \"daily_sync_time\": \"14:00\",\n \"pause_after_trial\": false,\n \"schema_status\": \"ready\",\n \"is_historical_sync\": true,\n \"schedule_type\": \"auto\",\n \"run_setup_tests\": true,\n \"networking_method\": \"Directly\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"data_delay_sensitivity\": \"NORMAL\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"schema.table\",\n \"service\": \"google_ads\",\n \"service_version\": 0,\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 360,\n \"connected_by\": \"priceless_odour\",\n \"succeeded_at\": \"2024-03-17T12:31:40.870504Z\",\n \"failed_at\": \"2024-04-01T18:13:25.043659Z\",\n \"data_delay_threshold\": 0,\n \"private_link_id\": \"link_id\",\n \"networking_method\": \"SshTunnel\",\n \"proxy_agent_id\": \"agent_id\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"source_sync_details\": {},\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"hybrid_deployment_agent_id\": \"agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n },\n \"message\": \"Connection has been updated\"\n}" }, { "name": "Not found error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"auth\": \"\",\n \"paused\": false,\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"sync_frequency\": 30,\n \"data_delay_threshold\": 7512,\n \"data_delay_sensitivity\": \"CUSTOM\",\n \"daily_sync_time\": \"14:00\",\n \"pause_after_trial\": false,\n \"schema_status\": \"ready\",\n \"is_historical_sync\": true,\n \"schedule_type\": \"auto\",\n \"run_setup_tests\": true,\n \"networking_method\": \"Directly\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections", ":connectionId" ], "variable": [ { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Connections", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connections?group_id=group_id&schema=schema&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ], "query": [ { "key": "group_id", "value": "group_id", "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." }, { "key": "schema", "value": "schema", "description": "Filter the list to connections whose schema name matches this value. Partial matches are not supported." }, { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all accessible connections within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections?group_id=group_id&schema=schema&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ], "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.", "key": "group_id", "value": "group_id" }, { "description": "Filter the list to connections whose schema name matches this value. Partial matches are not supported.", "key": "schema", "value": "schema" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"connected_by\": \"user_id\",\n \"created_at\": \"2024-12-01T15:43:29.013729Z\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"gsheets.table\",\n \"service\": \"google_sheets\",\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 360,\n \"config\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\n },\n \"service_version\": 0,\n \"succeeded_at\": \"2024-12-01T15:43:29.013729Z\",\n \"failed_at\": \"2024-12-01T15:43:29.013729Z\",\n \"data_delay_threshold\": 3844,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"private_link_id\": \"string\",\n \"networking_method\": \"PrivateLink\",\n \"proxy_agent_id\": \"string\",\n \"source_sync_details\": {},\n \"hybrid_deployment_agent_id\": \"string\",\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"connected_by\": \"user_id\",\n \"created_at\": \"2024-12-01T15:43:29.013729Z\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"gsheets.table\",\n \"service\": \"google_sheets\",\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 360,\n \"config\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"service_version\": 0,\n \"succeeded_at\": \"2024-12-01T15:43:29.013729Z\",\n \"failed_at\": \"2024-12-01T15:43:29.013729Z\",\n \"data_delay_threshold\": 6050,\n \"data_delay_sensitivity\": \"LOW\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"private_link_id\": \"string\",\n \"networking_method\": \"Directly\",\n \"proxy_agent_id\": \"string\",\n \"source_sync_details\": {},\n \"hybrid_deployment_agent_id\": \"string\",\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Connections list retrieved successfully\"\n}" }, { "name": "Unauthorized error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections?group_id=group_id&schema=schema&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ], "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.", "key": "group_id", "value": "group_id" }, { "description": "Filter the list to connections whose schema name matches this value. Partial matches are not supported.", "key": "schema", "value": "schema" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Method not allowed error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections?group_id=group_id&schema=schema&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ], "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.", "key": "group_id", "value": "group_id" }, { "description": "Filter the list to connections whose schema name matches this value. Partial matches are not supported.", "key": "schema", "value": "schema" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connections?group_id=group_id&schema=schema&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ], "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.", "key": "group_id", "value": "group_id" }, { "description": "Filter the list to connections whose schema name matches this value. Partial matches are not supported.", "key": "schema", "value": "schema" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a Connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] }, "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)." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"data_delay_sensitivity\": \"NORMAL\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"schema.table\",\n \"service\": \"google_ads\",\n \"service_version\": 0,\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 5,\n \"connected_by\": \"priceless_odour\",\n \"succeeded_at\": \"2024-03-17T12:31:40.870504Z\",\n \"failed_at\": \"2024-04-01T18:13:25.043659Z\",\n \"data_delay_threshold\": 0,\n \"private_link_id\": \"link_id\",\n \"networking_method\": \"PrivateLink\",\n \"proxy_agent_id\": \"agent_id\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"source_sync_details\": {},\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"hybrid_deployment_agent_id\": \"agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n },\n \"message\": \"Connection has been created\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not acceptable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Not Acceptable", "code": 406, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unsupported media type", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"google_ads\",\n \"trust_certificates\": true,\n \"trust_fingerprints\": true,\n \"run_setup_tests\": true,\n \"paused\": false,\n \"pause_after_trial\": false,\n \"sync_frequency\": 180,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"data_delay_threshold\": 0,\n \"daily_sync_time\": \"14:00\",\n \"schedule_type\": \"auto\",\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"proxy_agent_id\": \"proxy_agent_id\",\n \"private_link_id\": \"private_link_id\",\n \"networking_method\": \"PrivateLink\",\n \"hybrid_deployment_agent_id\": \"hybrid_deployment_agent_id\",\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"esm_id\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "connector-sdk", "item": [ { "name": "packages", "item": [ { "name": "{package_id}", "item": [ { "name": "download", "item": [ { "name": "Download Connector SDK Package", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id", "download" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the 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" }, "response": [ { "name": "Package file downloaded successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id", "download" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Package not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id", "download" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve Connector SDK Package Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] }, "description": "Returns details for a specific Connector SDK package." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-14T19:30:00Z\",\n \"created_by\": \"user_id\",\n \"id\": \"package_id\",\n \"last_updated_by\": \"user_id\",\n \"updated_at\": \"2024-01-14T20:15:00Z\",\n \"connection_id\": \"connection_id\",\n \"file_sha256_hash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\"\n },\n \"message\": \"Connector SDK package details retrieved successfully\"\n}" }, { "name": "Package not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete Connector SDK Package", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the 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" }, "response": [ { "name": "Package deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Package deleted successfully\"\n}" }, { "name": "Package is associated with a connection and cannot be deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Package not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update Connector SDK Package", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] }, "description": "Updates an existing Connector SDK package by uploading a new version of the connector code.\n\nAll connections using this package will automatically use the updated code on their next sync.\n" }, "response": [ { "name": "Package updated successfully", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-14T19:30:00Z\",\n \"created_by\": \"user_id\",\n \"id\": \"package_id\",\n \"last_updated_by\": \"user_id\",\n \"updated_at\": \"2024-01-14T20:15:00Z\",\n \"connection_id\": \"connection_id\",\n \"file_sha256_hash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\"\n },\n \"message\": \"Package updated successfully\"\n}" }, { "name": "Invalid package file or missing file parameter", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "User is not the package owner or an account administrator", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Package not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages/:package_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages", ":package_id" ], "variable": [ { "key": "package_id", "value": "package_id", "description": "The unique identifier for the Connector SDK package." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Connector SDK Packages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all Connector SDK packages in your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-14T19:30:00Z\",\n \"created_by\": \"user_id\",\n \"id\": \"package_id\",\n \"last_updated_by\": \"user_id\",\n \"updated_at\": \"2024-01-14T20:15:00Z\",\n \"connection_id\": \"connection_id\",\n \"file_sha256_hash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\"\n },\n {\n \"created_at\": \"2024-01-14T19:30:00Z\",\n \"created_by\": \"user_id\",\n \"id\": \"package_id\",\n \"last_updated_by\": \"user_id\",\n \"updated_at\": \"2024-01-14T20:15:00Z\",\n \"connection_id\": \"connection_id\",\n \"file_sha256_hash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Connector SDK packages retrieved successfully\"\n}" } ] }, { "name": "Create Connector SDK Package", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages" ] }, "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" }, "response": [ { "name": "Package created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-14T19:30:00Z\",\n \"created_by\": \"user_id\",\n \"id\": \"package_id\",\n \"last_updated_by\": \"user_id\",\n \"updated_at\": \"2024-01-14T20:15:00Z\",\n \"connection_id\": \"connection_id\",\n \"file_sha256_hash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\"\n },\n \"message\": \"Package created successfully\"\n}" }, { "name": "Invalid package file or missing file parameter", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The ZIP file containing the Connector SDK package.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/connector-sdk/packages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connector-sdk", "packages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "destinations", "item": [ { "name": "{destinationId}", "item": [ { "name": "certificates", "item": [ { "name": "{hash}", "item": [ { "name": "Retrieve Destination Certificate Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] }, "description": "Returns details of the certificate approved for the specified destination with specified certificate hash." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n },\n \"message\": \"Destination certificate details retrieved successfully\"\n}" }, { "name": "Certificate with specified hash not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Revoke Destination Certificate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] }, "description": "Revokes a certificate, so Fivetran no longer trusts it while connecting to the destination database." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Certificate 'string' has been revoked for destination 'string'\"\n}" }, { "name": "Certificate with specified hash not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List Certificates Approved for the Destination", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "description": "Returns the list of approved certificates for the specified destination." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n },\n {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Destination certificates retrieved successfully\"\n}" }, { "name": "Destination not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Approve a Certificate for the Destination", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"hash\": \"jhg5UI7fgrI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g\",\n \"name\": \"Certificate Name\",\n \"public_key\": \"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537\",\n \"sha1\": \"c8de1d13vtu435ilj435lj345796d8jh7hk8hgk\",\n \"sha256\": \"5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f\",\n \"type\": \"TLS\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2023-08-20T10:15:20.677566Z\"\n },\n \"message\": \"The certificate has been approved.\"\n}" }, { "name": "Missing `hash` or `encoded_cert` fields in request payload", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Destination not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"encoded_cert\": \"MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...\",\n \"hash\": \"jhg5UI7fgrI6yy...\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "certificates" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "fingerprints", "item": [ { "name": "{hash}", "item": [ { "name": "Retrieve Destination Fingerprint Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] }, "description": "Returns SSH fingerprint details approved for specified destination with specified hash" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n },\n \"message\": \"Destination fingerprint details retrieved successfully\"\n}" }, { "name": "Fingerprint with specified hash not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Revoke Destination Fingerprint", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] }, "description": "Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the destination database through an SSH tunnel." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Fingerprint with hash = 'string' has been revoked for destination id = 'string'\"\n}" }, { "name": "Fingerprint with specified hash not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints/:hash", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints", ":hash" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." }, { "key": "hash", "value": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List Fingerprints Approved for the Destination", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "description": "Returns the list of approved SSH fingerprints for specified destination" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n },\n {\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Destination fingerprints retrieved successfully\"\n}" }, { "name": "Destination not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Approve a Fingerprint for the Destination", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "description": "Approves a fingerprint, enabling Fivetran to trust it for a destination database and establish connections via an SSH tunnel." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hash\": \"eUtPirI6yy...\",\n \"id\": \"Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\",\n \"validated_by\": \"user_id\",\n \"validated_date\": \"2024-01-01T00:00:00Z\"\n}" }, { "name": "Missing `hash` or `public_key` fields in request payload", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Destination not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"hash\": \"eUtPirI6yy...\",\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/fingerprints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "fingerprints" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "test", "item": [ { "name": "Run Destination Setup Tests", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "test" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "description": "Runs the setup tests for an existing destination within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "test" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Setup tests have been completed\",\n \"data\": {\n \"id\": \"destination_id\",\n \"group_id\": \"group_id\",\n \"service\": \"postgres_rds_warehouse\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-8\",\n \"setup_status\": \"incomplete\",\n \"setup_tests\": [\n {\n \"title\": \"Connecting to SSH tunnel\",\n \"status\": \"FAILED\",\n \"message\": \"Auth fail\"\n }\n ],\n \"config\": {\n \"public_key\": \"ssh-rsa ... fivetran user key\",\n \"database\": \"database_name\",\n \"password\": \"******\",\n \"tunnel_port\": \"22\",\n \"port\": \"5432\",\n \"host\": \"test.host.com\",\n \"tunnel_host\": \"test.tunnel.host.com\",\n \"user\": \"user_name\",\n \"connection_method\": \"SshTunnel\",\n \"tunnel_user\": \"tunnel_user_name\"\n }\n }\n}" }, { "name": "Not found error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"trust_certificates\": true,\n \"trust_fingerprints\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId", "test" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve Destination Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"decent_dropsy\",\n \"group_id\": \"decent_dropsy\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"setup_status\": \"connected\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"******\"\n }\n }\n}" }, { "name": "Not found error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a Destination", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "description": "Deletes a destination from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Destination with id 'destination_id' has been deleted\"\n}" }, { "name": "Not found error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Conflict error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Destination", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"region\": \"GCP_AUSTRALIA_SOUTHEAST1\",\n \"time_zone_offset\": \"+10\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 1433,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] }, "description": "Updates information for an existing destination within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"region\": \"GCP_AUSTRALIA_SOUTHEAST1\",\n \"time_zone_offset\": \"+10\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 1433,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Destination has been updated\",\n \"data\": {\n \"id\": \"decent_dropsy\",\n \"group_id\": \"decent_dropsy\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_AUSTRALIA_SOUTHEAST1\",\n \"time_zone_offset\": \"+10\",\n \"setup_status\": \"connected\",\n \"setup_tests\": [\n {\n \"title\": \"Host Connection\",\n \"status\": \"PASSED\",\n \"message\": \"\"\n },\n {\n \"title\": \"Database Connection\",\n \"status\": \"PASSED\",\n \"message\": \"\"\n },\n {\n \"title\": \"Permission Test\",\n \"status\": \"PASSED\",\n \"message\": \"\"\n }\n ],\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 1433,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"******\"\n }\n }\n}" }, { "name": "Not found error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"region\": \"GCP_AUSTRALIA_SOUTHEAST1\",\n \"time_zone_offset\": \"+10\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 1433,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations/:destinationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations", ":destinationId" ], "variable": [ { "key": "destinationId", "value": "destinationId", "description": "The unique identifier for the destination within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Destinations Within Account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/destinations?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all accessible destinations within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/destinations?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"decent_dropsy\",\n \"group_id\": \"decent_dropsy\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"setup_status\": \"connected\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"******\"\n }\n }\n}" } ] }, { "name": "Create a Destination", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"target_group_id\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations" ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"target_group_id\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Destination has been created\",\n \"data\": {\n \"id\": \"decent_dropsy\",\n \"group_id\": \"decent_dropsy\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"setup_status\": \"connected\",\n \"setup_tests\": [\n {\n \"title\": \"Host Connection\",\n \"status\": \"PASSED\",\n \"message\": \"\"\n },\n {\n \"title\": \"Database Connection\",\n \"status\": \"PASSED\",\n \"message\": \"\"\n },\n {\n \"title\": \"Permission Test\",\n \"status\": \"PASSED\",\n \"message\": \"\"\n }\n ],\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"******\"\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"target_group_id\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"InvalidInput\",\n \"message\": \"Unsupported service 'service_id'\"\n}" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"target_group_id\",\n \"service\": \"snowflake\",\n \"region\": \"GCP_US_EAST4\",\n \"time_zone_offset\": \"-5\",\n \"config\": {\n \"host\": \"your-account.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"fivetran\",\n \"auth\": \"PASSWORD\",\n \"user\": \"fivetran_user\",\n \"password\": \"123456\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/destinations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "destinations" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Destination with id not found\"\n}" } ] } ] }, { "name": "external-logging", "item": [ { "name": "account", "item": [ { "name": "test", "item": [ { "name": "Run Account Log Service Setup Tests", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/account/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account", "test" ] }, "description": "Runs the setup tests for the account-level [logging service](/docs/logs/external-logs)." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/account/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account", "test" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Account external logging service setup tests have been completed\"\n}" } ] } ] }, { "name": "Retrieve Account Log Service", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] }, "description": "Returns the account-level [logging service](/docs/logs/external-logs) if it exists." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n },\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Account external logging service details retrieved successfully\"\n}" } ] }, { "name": "Create Account Log Service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service\": \"log_service_type\",\n \"enabled\": true,\n \"config\": {},\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] }, "description": "Creates an account-level [logging service](/docs/logs/external-logs)." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"service\": \"log_service_type\",\n \"enabled\": true,\n \"config\": {},\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n },\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Account external logging service has been added\"\n}" } ] }, { "name": "Delete Account Log Service", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] }, "description": "Deletes the account-level [logging service](/docs/logs/external-logs)." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Account external logging service has been deleted\"\n}" } ] }, { "name": "Update Account Log Service", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"config\": \"\",\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] }, "description": "Updates information for the account-level [logging service](/docs/logs/external-logs)." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"config\": \"\",\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n },\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Account external logging service has been updated\"\n}" } ] } ] }, { "name": "{logId}", "item": [ { "name": "test", "item": [ { "name": "Run Group Log Service Setup Tests", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId", "test" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] }, "description": "Runs the setup tests for an existing group-level [logging service](/docs/logs/external-logs) within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId", "test" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Setup tests have been completed\"\n}" } ] } ] }, { "name": "Retrieve Group Log Service Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] }, "description": "Returns a group-level [logging service](/docs/logs/external-logs) object if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n },\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"External logging service details retrieved successfully\"\n}" } ] }, { "name": "Delete a Group Log Service", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] }, "description": "Deletes a group-level [logging service](/docs/logs/external-logs) from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"External logging service with id 'string' has been deleted\"\n}" } ] }, { "name": "Update a Group Log Service", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"config\": {},\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] }, "description": "Updates information for an existing group-level [logging service](/docs/logs/external-logs) within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"config\": {},\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging/:logId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging", ":logId" ], "variable": [ { "key": "logId", "value": "logId", "description": "The unique identifier for the log service within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n },\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"External logging service has been updated\"\n}" } ] } ] }, { "name": "List All Log Services within Account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-logging?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all accessible [logging services](/docs/logs/external-logs) within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-logging?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n }\n },\n {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n }\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"External logging services retrieved successfully\"\n}" } ] }, { "name": "Create a Group Log Service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"log_service_type\",\n \"enabled\": true,\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging" ] }, "description": "Creates a new group-level [logging service](/docs/logs/external-logs) within a specified group in your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"group_id\",\n \"service\": \"log_service_type\",\n \"enabled\": true,\n \"run_setup_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-logging", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-logging" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"log_id\",\n \"service\": \"log_service_type\",\n \"status\": {\n \"tasks\": [\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n },\n {\n \"code\": \"reconnect_log\",\n \"message\": \"Reconnect Logging Service\",\n \"details\": \"Please provide required permissions\"\n }\n ],\n \"setup_state\": \"connected\"\n },\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"External logging service has been added\"\n}" } ] } ] }, { "name": "external-secrets-managers", "item": [ { "name": "{esmId}", "item": [ { "name": "entities", "item": [ { "name": "List Entities Using an External Secrets Manager", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId/entities?type=source", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId", "entities" ], "query": [ { "key": "type", "value": "source", "description": "Filter by entity type. Accepted values are source, destination, or all." } ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] }, "description": "Returns a list of source connections and destinations that are using a specific External Secrets Manager." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId/entities?type=source", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId", "entities" ], "query": [ { "description": "Filter by entity type. Accepted values are source, destination, or all.", "key": "type", "value": "source" } ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"connection_id\",\n \"type\": \"SOURCE\",\n \"name\": \"my_schema\",\n \"enabled\": true,\n \"secret_manager_id\": \"lucky_tiger\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\"\n }\n ],\n \"next_cursor\": \"eyJza2lwIjoyfQ\"\n }\n}" } ] } ] }, { "name": "Retrieve External Secrets Manager Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] }, "description": "Returns the details of an existing External Secrets Manager instance." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"lucky_tiger\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"name\": \"My AWS Secrets Manager\",\n \"is_hybrid_deployment\": false,\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-06-01T00:00:00.000000Z\",\n \"config\": {\n \"role_arn\": \"arn:aws:iam::123456789012:role/FivetranRole\",\n \"external_id\": \"fivetran_external_id\"\n }\n }\n}" }, { "name": "External Secrets Manager not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"External Secrets Manager with 'lucky_tiger' id is not found.\"\n}" } ] }, { "name": "Delete an External Secrets Manager", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] }, "description": "Deletes an External Secrets Manager instance from your Fivetran account. The instance must not be in use by any source connections or destinations." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"External Secrets Manager 'lucky_tiger' has been deleted.\"\n}" }, { "name": "External Secrets Manager is still in use", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Failed to delete External Secrets Manager with 'lucky_tiger' id, because it is used by 1 connection(s) and 0 destination(s).\"\n}" }, { "name": "External Secrets Manager not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"External Secrets Manager with 'lucky_tiger' id is not found.\"\n}" } ] }, { "name": "Update an External Secrets Manager", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"config\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] }, "description": "Updates the configuration of an existing External Secrets Manager instance." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"lucky_tiger\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"name\": \"My AWS Secrets Manager\",\n \"is_hybrid_deployment\": false,\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-06-01T00:00:00.000000Z\",\n \"config\": {\n \"role_arn\": \"arn:aws:iam::123456789012:role/FivetranRole\",\n \"external_id\": \"fivetran_external_id\"\n }\n }\n}" }, { "name": "Validation error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"ESM config is required.\"\n}" }, { "name": "External Secrets Manager not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers/:esmId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers", ":esmId" ], "variable": [ { "key": "esmId", "value": "lucky_tiger", "description": "The unique identifier of the External Secrets Manager instance." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"External Secrets Manager with 'lucky_tiger' id is not found.\"\n}" } ] } ] }, { "name": "List all External Secrets Managers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all External Secrets Manager instances within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"lucky_tiger\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"name\": \"My AWS Secrets Manager\",\n \"is_hybrid_deployment\": false,\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-06-01T00:00:00.000000Z\"\n }\n ],\n \"next_cursor\": \"eyJza2lwIjoyfQ\"\n }\n}" } ] }, { "name": "Create an External Secrets Manager", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"name\": \"My AWS Secrets Manager\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"is_hybrid_deployment\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers" ] }, "description": "Creates a new External Secrets Manager instance within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"name\": \"My AWS Secrets Manager\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"is_hybrid_deployment\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"lucky_tiger\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"name\": \"My AWS Secrets Manager\",\n \"is_hybrid_deployment\": false,\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-06-01T00:00:00.000000Z\",\n \"config\": {\n \"role_arn\": \"arn:aws:iam::123456789012:role/FivetranRole\",\n \"external_id\": \"fivetran_external_id\"\n }\n }\n}" }, { "name": "Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"name\": \"My AWS Secrets Manager\",\n \"type\": \"AWS_SECRET_MANAGER\",\n \"is_hybrid_deployment\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"ESM config is required.\"\n}" } ] } ] }, { "name": "external-secrets-managers-entities", "item": [ { "name": "List All Entities Using External Secrets Managers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers-entities?esm_id=lucky_tiger&type=source", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers-entities" ], "query": [ { "key": "esm_id", "value": "lucky_tiger", "description": "Filter by a specific External Secrets Manager ID." }, { "key": "type", "value": "source", "description": "Filter by entity type. Accepted values are source, destination, or all." } ] }, "description": "Returns a list of all source connections and destinations that are using any External Secrets Manager within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/external-secrets-managers-entities?esm_id=lucky_tiger&type=source", "host": [ "{{baseUrl}}" ], "path": [ "v1", "external-secrets-managers-entities" ], "query": [ { "description": "Filter by a specific External Secrets Manager ID.", "key": "esm_id", "value": "lucky_tiger" }, { "description": "Filter by entity type. Accepted values are source, destination, or all.", "key": "type", "value": "source" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"connection_id\",\n \"type\": \"SOURCE\",\n \"name\": \"my_schema\",\n \"enabled\": true,\n \"secret_manager_id\": \"lucky_tiger\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\"\n }\n ],\n \"next_cursor\": \"eyJza2lwIjoyfQ\"\n }\n}" } ] } ] }, { "name": "groups", "item": [ { "name": "{groupId}", "item": [ { "name": "connections", "item": [ { "name": "List All Connections within a Group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/connections?schema=schema_name&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "connections" ], "query": [ { "key": "schema", "value": "schema_name", "description": "The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination." }, { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns a list of information about all connections within a group in your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/connections?schema=schema_name&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "connections" ], "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.", "key": "schema", "value": "schema_name" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"connected_by\": \"user_id\",\n \"created_at\": \"2024-12-01T15:43:29.013729Z\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"gsheets.table\",\n \"service\": \"google_sheets\",\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 360,\n \"config\": {\n \"key_0\": {}\n },\n \"service_version\": 0,\n \"succeeded_at\": \"2024-12-01T15:43:29.013729Z\",\n \"failed_at\": \"2024-12-01T15:43:29.013729Z\",\n \"data_delay_threshold\": 6527,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"private_link_id\": \"string\",\n \"networking_method\": \"Unknown\",\n \"proxy_agent_id\": \"string\",\n \"source_sync_details\": {},\n \"hybrid_deployment_agent_id\": \"string\",\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"FIVETRAN_NAMING\",\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n {\n \"connected_by\": \"user_id\",\n \"created_at\": \"2024-12-01T15:43:29.013729Z\",\n \"group_id\": \"group_id\",\n \"id\": \"connection_id\",\n \"pause_after_trial\": false,\n \"paused\": false,\n \"schedule_type\": \"auto\",\n \"schema\": \"gsheets.table\",\n \"service\": \"google_sheets\",\n \"status\": {\n \"is_historical_sync\": false,\n \"setup_state\": \"connected\",\n \"sync_state\": \"scheduled\",\n \"update_state\": \"delayed\",\n \"tasks\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": \"string\"\n }\n ],\n \"schema_status\": \"ready\",\n \"rescheduled_for\": \"2024-12-01T15:43:29.013729Z\"\n },\n \"sync_frequency\": 360,\n \"config\": {\n \"key_0\": {}\n },\n \"service_version\": 0,\n \"succeeded_at\": \"2024-12-01T15:43:29.013729Z\",\n \"failed_at\": \"2024-12-01T15:43:29.013729Z\",\n \"data_delay_threshold\": 7541,\n \"data_delay_sensitivity\": \"NORMAL\",\n \"daily_sync_time\": \"14:00\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ],\n \"private_link_id\": \"string\",\n \"networking_method\": \"PrivateLink\",\n \"proxy_agent_id\": \"string\",\n \"source_sync_details\": {},\n \"hybrid_deployment_agent_id\": \"string\",\n \"connect_card\": {\n \"token\": \"eyJ0e...\",\n \"uri\": \"https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true\"\n },\n \"connect_card_config\": {\n \"redirect_uri\": \"https://your.site/path\",\n \"hide_setup_guide\": true,\n \"all_fields\": true\n },\n \"destination_configuration\": {\n \"virtual_warehouse\": \"virtual_warehouse\"\n },\n \"destination_schema_names\": \"SOURCE_NAMING\",\n \"external_secrets_manager_id\": \"string\",\n \"external_secrets_keys_config\": {\n \"key_0\": \"string\"\n }\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Group connections retrieved successfully\"\n}" } ] } ] }, { "name": "public-key", "item": [ { "name": "Retrieve Group Public SSH Key", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/public-key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "public-key" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns public key from SSH key pair associated with the group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/public-key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "public-key" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"public_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key\"\n },\n \"message\": \"Group SSH public key retrieved successfully\"\n}" } ] } ] }, { "name": "service-account", "item": [ { "name": "Retrieve Group Service Account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/service-account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "service-account" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns Fivetran service account associated with the group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/service-account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "service-account" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"service_account\": \"service_account\"\n },\n \"message\": \"Group service account retrieved successfully\"\n}" } ] } ] }, { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "Remove a User from a Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "users", ":userId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Removes an existing user from a group in your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "users", ":userId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"User with id 'string' has been removed from the group\"\n}" } ] } ] }, { "name": "List All Users within a Group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/users?cursor=cursor_value&limit=100&active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "users" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." }, { "key": "active", "value": "true", "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." } ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns a list of information about all users within a group in your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/users?cursor=cursor_value&limit=100&active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "users" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" }, { "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.", "key": "active", "value": "true" } ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n },\n {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Group users retrieved successfully\"\n}" } ] }, { "name": "Add a User to a Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@email.value\",\n \"role\": \"Owner\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "users" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Adds an existing user to a group in your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@email.value\",\n \"role\": \"Owner\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/groups/:groupId/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId", "users" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"User has been added to the group\"\n}" } ] } ] }, { "name": "Retrieve Group Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns a group object if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"group_id\",\n \"name\": \"Group_Name\"\n },\n \"message\": \"Group details retrieved successfully\"\n}" } ] }, { "name": "Delete a Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Deletes a group from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Group with id 'string' has been deleted\"\n}" } ] }, { "name": "Update a Group", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated_Group_Name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Updates information for an existing group within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated_Group_Name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"group_id\",\n \"name\": \"Group_Name\"\n },\n \"message\": \"Group has been updated\"\n}" } ] } ] }, { "name": "List All Destinations within Account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/groups?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all groups within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/groups?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"group_id\",\n \"name\": \"Group_Name\"\n },\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"group_id\",\n \"name\": \"Group_Name\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Groups retrieved successfully\"\n}" } ] }, { "name": "Create a Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Group_Name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups" ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Group_Name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "groups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"group_id\",\n \"name\": \"Group_Name\"\n },\n \"message\": \"Group has been created\"\n}" } ] } ] }, { "name": "hvr", "item": [ { "name": "register-hub", "item": [ { "name": "Register Hub", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"fingerprint_value\",\n \"port\": 1234,\n \"hub_server_url\": \"hub_server_url\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hvr/register-hub", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hvr", "register-hub" ] }, "description": "Register a new hub within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"fingerprint_value\",\n \"port\": 1234,\n \"hub_server_url\": \"hub_server_url\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hvr/register-hub", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hvr", "register-hub" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"access_token\": \"access_token_value\",\n \"registration_id\": \"registration_id\"\n },\n \"message\": \"HVR hub has been registered\"\n}" } ] } ] } ] }, { "name": "hybrid-deployment-agents", "item": [ { "name": "{agentId}", "item": [ { "name": "re-auth", "item": [ { "name": "Regenerate Authentication Keys", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId/re-auth", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId", "re-auth" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] }, "description": "Regenerate authentication for a Hybrid Deployment Agent." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId/re-auth", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId", "re-auth" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_by\": \"created_by\",\n \"deployment_type\": \"DOCKER\",\n \"display_name\": \"display_name\",\n \"enabled\": true,\n \"group_id\": \"group_id\",\n \"id\": \"agent_id\",\n \"last_used_at\": \"2024-12-01T15:43:29.013729Z\",\n \"online\": true,\n \"registered_at\": \"2024-12-01T15:43:29.013729Z\",\n \"updated_at\": \"2024-12-01T15:43:29.013729Z\",\n \"version\": \"version\",\n \"files\": {\n \"auth_json\": \"Base64 {... auth.json contents ...}\",\n \"config_json\": \"Base64 {... config.json contents ...}\",\n \"docker_compose_yaml\": \"Base64 {... docker-compose.yaml contents ...}\"\n },\n \"token\": \"token_value\"\n },\n \"message\": \"Hybrid deployment agent re-authentication successful\"\n}" }, { "name": "Hybrid Deployment Agent not found in group.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId/re-auth", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId", "re-auth" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reset-credentials", "item": [ { "name": "Reset Agent Credentials", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId/reset-credentials", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId", "reset-credentials" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] }, "description": "Reset credentials for a Hybrid Deployment Agent." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId/reset-credentials", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId", "reset-credentials" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Successfully reset credentials the agent with id = string\"\n}" }, { "name": "Hybrid Deployment Agent not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId/reset-credentials", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId", "reset-credentials" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Returns Hybrid Deployment Agent Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] }, "description": "Returns Hybrid Deployment Agent Details." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_by\": \"created_by\",\n \"deployment_type\": \"DOCKER\",\n \"display_name\": \"display_name\",\n \"enabled\": true,\n \"group_id\": \"group_id\",\n \"id\": \"agent_id\",\n \"last_used_at\": \"2024-12-01T15:43:29.013729Z\",\n \"online\": true,\n \"registered_at\": \"2024-12-01T15:43:29.013729Z\",\n \"updated_at\": \"2024-12-01T15:43:29.013729Z\",\n \"version\": \"version\",\n \"usage\": [\n {\n \"connection_id\": \"connection_id\",\n \"schema\": \"schema_name\",\n \"service\": \"service\"\n },\n {\n \"connection_id\": \"connection_id\",\n \"schema\": \"schema_name\",\n \"service\": \"service\"\n }\n ]\n },\n \"message\": \"Hybrid deployment agent details retrieved successfully\"\n}" } ] }, { "name": "Delete a Hybrid Deployment Agent", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] }, "description": "Delete a Hybrid Deployment Agent." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Hybrid deployment agent with id = string has been deleted.\"\n}" }, { "name": "Hybrid Deployment Agent not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "Hybrid Deployment Agent Id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List Hybrid Deployment Agents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents?groupId=group_id&cursor=string&limit=1761", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents" ], "query": [ { "key": "groupId", "value": "group_id", "description": "The Fivetran Group Id." }, { "key": "cursor", "value": "string" }, { "key": "limit", "value": "1761" } ] }, "description": "Returns list of all Hybrid Deployment Agents within your Fivetran account, along with usage. Optionally filtered to a single group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents?groupId=group_id&cursor=string&limit=1761", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents" ], "query": [ { "description": "The Fivetran Group Id.", "key": "groupId", "value": "group_id" }, { "key": "cursor", "value": "string" }, { "key": "limit", "value": "1761" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_by\": \"created_by\",\n \"deployment_type\": \"DOCKER\",\n \"display_name\": \"display_name\",\n \"enabled\": true,\n \"group_id\": \"group_id\",\n \"id\": \"agent_id\",\n \"last_used_at\": \"2024-12-01T15:43:29.013729Z\",\n \"online\": true,\n \"registered_at\": \"2024-12-01T15:43:29.013729Z\",\n \"updated_at\": \"2024-12-01T15:43:29.013729Z\",\n \"version\": \"version\",\n \"usage\": [\n {\n \"connection_id\": \"connection_id\",\n \"schema\": \"schema_name\",\n \"service\": \"service\"\n },\n {\n \"connection_id\": \"connection_id\",\n \"schema\": \"schema_name\",\n \"service\": \"service\"\n }\n ]\n },\n {\n \"created_by\": \"created_by\",\n \"deployment_type\": \"DOCKER\",\n \"display_name\": \"display_name\",\n \"enabled\": true,\n \"group_id\": \"group_id\",\n \"id\": \"agent_id\",\n \"last_used_at\": \"2024-12-01T15:43:29.013729Z\",\n \"online\": true,\n \"registered_at\": \"2024-12-01T15:43:29.013729Z\",\n \"updated_at\": \"2024-12-01T15:43:29.013729Z\",\n \"version\": \"version\",\n \"usage\": [\n {\n \"connection_id\": \"connection_id\",\n \"schema\": \"schema_name\",\n \"service\": \"service\"\n },\n {\n \"connection_id\": \"connection_id\",\n \"schema\": \"schema_name\",\n \"service\": \"service\"\n }\n ]\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Hybrid deployment agents retrieved successfully\"\n}" } ] }, { "name": "Create a Hybrid Deployment Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accept_terms\": true,\n \"display_name\": \"display_name\",\n \"env_type\": \"DOCKER\",\n \"group_id\": \"group_id\",\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents" ] }, "description": "Creates a new Hybrid Deployment Agent in a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accept_terms\": true,\n \"display_name\": \"display_name\",\n \"env_type\": \"DOCKER\",\n \"group_id\": \"group_id\",\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_by\": \"created_by\",\n \"deployment_type\": \"DOCKER\",\n \"display_name\": \"display_name\",\n \"enabled\": true,\n \"group_id\": \"group_id\",\n \"id\": \"agent_id\",\n \"last_used_at\": \"2024-12-01T15:43:29.013729Z\",\n \"online\": true,\n \"registered_at\": \"2024-12-01T15:43:29.013729Z\",\n \"updated_at\": \"2024-12-01T15:43:29.013729Z\",\n \"version\": \"version\",\n \"files\": {\n \"auth_json\": \"Base64 {... auth.json contents ...}\",\n \"config_json\": \"Base64 {... config.json contents ...}\",\n \"docker_compose_yaml\": \"Base64 {... docker-compose.yaml contents ...}\"\n },\n \"token\": \"token_value\"\n },\n \"message\": \"Hybrid deployment agent has been created\"\n}" }, { "name": "Missing name or license not accepted in the payload.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accept_terms\": true,\n \"display_name\": \"display_name\",\n \"env_type\": \"DOCKER\",\n \"group_id\": \"group_id\",\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Group not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accept_terms\": true,\n \"display_name\": \"display_name\",\n \"env_type\": \"DOCKER\",\n \"group_id\": \"group_id\",\n \"auth_type\": \"AUTO\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/hybrid-deployment-agents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hybrid-deployment-agents" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "metadata", "item": [ { "name": "connector-types", "item": [ { "name": "{service}", "item": [ { "name": "Retrieve Connector Configuration Metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/metadata/connector-types/:service", "host": [ "{{baseUrl}}" ], "path": [ "v1", "metadata", "connector-types", ":service" ], "variable": [ { "key": "service", "value": "google_ads", "description": "[The connector type](https://fivetran.com/docs/rest-api/getting-started#commonterms) identifier within the Fivetran system" } ] }, "description": "Returns metadata of configuration parameters and authorization parameters for a specified connector type." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/metadata/connector-types/:service", "host": [ "{{baseUrl}}" ], "path": [ "v1", "metadata", "connector-types", ":service" ], "variable": [ { "key": "service", "value": "google_ads", "description": "[The connector type](https://fivetran.com/docs/rest-api/getting-started#commonterms) identifier within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"google_ads\",\n \"name\": \"Google Ads\",\n \"type\": \"Marketing\",\n \"description\": \"Google Ads is an online advertising platform\",\n \"icons\": [\n \"string\",\n \"string\"\n ],\n \"config\": {},\n \"auth\": {},\n \"icon_url\": \"https://fivetran.com/integrations/google_ads/resources/google-ads.png\",\n \"link_to_docs\": \"https://fivetran.com/docs/connectors/applications/google-ads\",\n \"connector_class\": \"standard\",\n \"supported_features\": [\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n },\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n }\n ],\n \"link_to_erd\": \"https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed\",\n \"service_status\": \"general_availability\",\n \"service_status_updated_at\": \"1972-07-30T12:38:45.851Z\",\n \"external_secrets_keys_config\": {}\n },\n \"message\": \"Connector configuration retrieved successfully\"\n}" } ] } ] }, { "name": "Retrieve Source Metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/metadata/connector-types?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "metadata", "connector-types" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/metadata/connector-types?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "metadata", "connector-types" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"google_ads\",\n \"name\": \"Google Ads\",\n \"type\": \"Marketing\",\n \"description\": \"Google Ads is an online advertising platform\",\n \"icons\": [\n \"string\",\n \"string\"\n ],\n \"icon_url\": \"https://fivetran.com/integrations/google_ads/resources/google-ads.png\",\n \"link_to_docs\": \"https://fivetran.com/docs/connectors/applications/google-ads\",\n \"connector_class\": \"lite\",\n \"supported_features\": [\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n },\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n }\n ],\n \"link_to_erd\": \"https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed\",\n \"service_status\": \"general_availability\",\n \"service_status_updated_at\": \"1957-12-18T06:55:49.473Z\"\n },\n {\n \"id\": \"google_ads\",\n \"name\": \"Google Ads\",\n \"type\": \"Marketing\",\n \"description\": \"Google Ads is an online advertising platform\",\n \"icons\": [\n \"string\",\n \"string\"\n ],\n \"icon_url\": \"https://fivetran.com/integrations/google_ads/resources/google-ads.png\",\n \"link_to_docs\": \"https://fivetran.com/docs/connectors/applications/google-ads\",\n \"connector_class\": \"standard\",\n \"supported_features\": [\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n },\n {\n \"id\": \"API_CONFIGURABLE\",\n \"notes\": \"...\"\n }\n ],\n \"link_to_erd\": \"https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed\",\n \"service_status\": \"general_availability\",\n \"service_status_updated_at\": \"2013-11-20T09:44:20.064Z\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Connectors list retrieved successfully\"\n}" } ] } ] } ] }, { "name": "private-links", "item": [ { "name": "{privateLinkId}", "item": [ { "name": "Retrieve Private Link Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] }, "description": "Returns a private link object if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"cloud_provider\": \"AWS\",\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"created_by\": \"user_id\",\n \"id\": \"private_link_id\",\n \"name\": \"PrivateLinkName\",\n \"region\": \"AWS_US_EAST_1\",\n \"service\": \"SQL_DATA_WAREHOUSE_AZURE\",\n \"state\": \"OK\",\n \"state_summary\": \"...\",\n \"host\": \"example.host.com\",\n \"account_id\": \"string\",\n \"resource_upstream_status\": \"IDLE\"\n },\n \"message\": \"Private link details retrieved successfully\"\n}" }, { "name": "Private Link not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a Private Link", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] }, "description": "Deletes a private link from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Private link with id 'string' is marked for deletion\"\n}" }, { "name": "Private Link not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Private Link", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] }, "description": "Updates information for an existing private link within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"cloud_provider\": \"AWS\",\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"created_by\": \"user_id\",\n \"id\": \"private_link_id\",\n \"name\": \"PrivateLinkName\",\n \"region\": \"AWS_US_EAST_1\",\n \"service\": \"SQL_DATA_WAREHOUSE_AZURE\",\n \"state\": \"OK\",\n \"state_summary\": \"...\",\n \"host\": \"example.host.com\",\n \"account_id\": \"string\",\n \"resource_upstream_status\": \"IDLE\"\n },\n \"message\": \"Private link has been updated\"\n}" }, { "name": "Private Link not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/private-links/:privateLinkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links", ":privateLinkId" ], "variable": [ { "key": "privateLinkId", "value": "privateLinkId", "description": "The unique identifier for the private link within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Private Links", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-links?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all private links." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/private-links?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"cloud_provider\": \"AWS\",\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"created_by\": \"user_id\",\n \"id\": \"private_link_id\",\n \"name\": \"PrivateLinkName\",\n \"region\": \"AWS_US_EAST_1\",\n \"service\": \"DATABRICKS_AWS\",\n \"state\": \"OK\",\n \"state_summary\": \"...\",\n \"host\": \"example.host.com\",\n \"account_id\": \"string\",\n \"resource_upstream_status\": \"IDLE\"\n },\n {\n \"cloud_provider\": \"AWS\",\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"created_by\": \"user_id\",\n \"id\": \"private_link_id\",\n \"name\": \"PrivateLinkName\",\n \"region\": \"AWS_US_EAST_1\",\n \"service\": \"DATABRICKS_GCP\",\n \"state\": \"OK\",\n \"state_summary\": \"...\",\n \"host\": \"example.host.com\",\n \"account_id\": \"string\",\n \"resource_upstream_status\": \"IDLE\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Private links retrieved successfully\"\n}" } ] }, { "name": "Create a Private Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"PrivateLinkName\",\n \"region\": \"GCP_US_EAST4\",\n \"service\": \"SQL_DATA_WAREHOUSE_AZURE\",\n \"config\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/private-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links" ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"PrivateLinkName\",\n \"region\": \"GCP_US_EAST4\",\n \"service\": \"SQL_DATA_WAREHOUSE_AZURE\",\n \"config\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/private-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-links" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"cloud_provider\": \"AWS\",\n \"created_at\": \"2023-12-01T15:43:29.013729Z\",\n \"created_by\": \"user_id\",\n \"id\": \"private_link_id\",\n \"name\": \"PrivateLinkName\",\n \"region\": \"AWS_US_EAST_1\",\n \"service\": \"POSTGRES_WAREHOUSE_AZURE\",\n \"state\": \"OK\",\n \"state_summary\": \"...\",\n \"host\": \"example.host.com\",\n \"account_id\": \"string\",\n \"resource_upstream_status\": \"IDLE\"\n },\n \"message\": \"Private link has been created\"\n}" } ] } ] }, { "name": "proxy", "item": [ { "name": "{agentId}", "item": [ { "name": "connections", "item": [ { "name": "List All Connections Attached to the Proxy Agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId", "connections" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] }, "description": "Returns all connections attached to the specified proxy agent within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId", "connections" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"connection_id\": \"connection_id\"\n }\n ],\n \"next_cursor\": \"eyJza2lwIjoyfQ\"\n }\n}" }, { "name": "Proxy Agent not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId", "connections" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Proxy Agent not found.\"\n}" } ] } ] }, { "name": "regenerate-secrets", "item": [ { "name": "Regenerate Secrets for Proxy Agent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId/regenerate-secrets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId", "regenerate-secrets" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] }, "description": "Regenerate secrets for proxy agent within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId/regenerate-secrets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId", "regenerate-secrets" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Created\",\n \"data\": {\n \"agent_id\": \"id\",\n \"auth_token\": \"auth_token\",\n \"client_cert\": \"client_cert\",\n \"client_private_key\": \"client_private_key\",\n \"orchestrator_host\": \"orchestrator.fivetran.com\",\n \"orchestrator_port\": 443\n },\n \"message\": \"Proxy agent secrets have been regenerated\"\n}" }, { "name": "Proxy agent not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId/regenerate-secrets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId", "regenerate-secrets" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Proxy Agent not found.\"\n}" } ] } ] }, { "name": "Retrieve Proxy Agent Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] }, "description": "Retrieves the details of the specified proxy agent." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"id\",\n \"account_id\": \"account_id\",\n \"registered_at\": \"2018-12-01T15:43:29.013729Z\",\n \"region\": \"GCP_US_EAST4\",\n \"created_by\": \"created_by\",\n \"display_name\": \"display_name\",\n \"version\": \"1.0.0\",\n \"status\": \"CONNECTED\",\n \"usage\": [\n {\n \"id\": \"connection_id\",\n \"schema\": \"schema\",\n \"service\": \"postgres\"\n }\n ]\n }\n}" }, { "name": "Proxy Agent not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Proxy Agent not found.\"\n}" } ] }, { "name": "Delete a Proxy Agent", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] }, "description": "Deletes the specified proxy agent from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Agent successfully deleted.\"\n}" }, { "name": "Proxy agent not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Proxy Agent not found.\"\n}" }, { "name": "Proxy agent have attached connections.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy/:agentId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy", ":agentId" ], "variable": [ { "key": "agentId", "value": "agentId", "description": "The unique identifier for the proxy agent within the Fivetran system." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Conflict\",\n \"message\": \"Proxy agent have attached connections.\"\n}" } ] } ] }, { "name": "List all Proxy Agents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/proxy?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all proxy agents within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/proxy?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"id\",\n \"account_id\": \"account_id\",\n \"registered_at\": \"2018-12-01T15:43:29.013729Z\",\n \"region\": \"GCP_US_EAST4\",\n \"created_by\": \"created_by\",\n \"display_name\": \"display_name\",\n \"version\": \"1.0.0\",\n \"status\": \"CONNECTED\",\n \"connector_count\": 3,\n \"destination_count\": 1\n }\n ],\n \"next_cursor\": \"eyJza2lwIjoyfQ\"\n }\n}" } ] }, { "name": "Create a Proxy Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"display_name\": \"display_name\",\n \"group_region\": \"GCP_US_EAST4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/proxy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy" ] }, "description": "Creates a new proxy agent within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"display_name\": \"display_name\",\n \"group_region\": \"GCP_US_EAST4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/proxy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Created\",\n \"data\": {\n \"agent_id\": \"id\",\n \"auth_token\": \"auth_token\",\n \"client_cert\": \"client_cert\",\n \"client_private_key\": \"client_private_key\",\n \"orchestrator_host\": \"orchestrator.fivetran.com\",\n \"orchestrator_port\": 443\n },\n \"message\": \"Proxy agent has been created\"\n}" }, { "name": "Group region not supported", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"display_name\": \"display_name\",\n \"group_region\": \"GCP_US_EAST4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/proxy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"InvalidInput\",\n \"message\": \"Group region not supported.\"\n}" }, { "name": "Proxy agent with same name already exists.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"display_name\": \"display_name\",\n \"group_region\": \"GCP_US_EAST4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/proxy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proxy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Conflict\",\n \"message\": \"Proxy agent with same name already exists.\"\n}" } ] } ] }, { "name": "roles", "item": [ { "name": "List all roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/roles?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "roles" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all predefined and custom roles within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/roles?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "roles" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"is_custom\": false,\n \"is_deprecated\": true,\n \"name\": \"Destination Administrator\",\n \"replacement_role_name\": \"Manage Destination\",\n \"scope\": \"TEAM\",\n \"description\": \"Role Description\"\n },\n {\n \"is_custom\": false,\n \"is_deprecated\": true,\n \"name\": \"Destination Administrator\",\n \"replacement_role_name\": \"Manage Destination\",\n \"scope\": \"DESTINATION\",\n \"description\": \"Role Description\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Roles list retrieved successfully\"\n}" } ] } ] }, { "name": "system-keys", "item": [ { "name": "{keyId}", "item": [ { "name": "rotate", "item": [ { "name": "Rotate a System Key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"updated_key\",\n \"permissions\": {\n \"expiration_period\": \"THREE_MONTHS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId/rotate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId", "rotate" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] }, "description": "Updates the secret value and expired_at date for an existing system key within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"updated_key\",\n \"permissions\": {\n \"expiration_period\": \"THREE_MONTHS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId/rotate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId", "rotate" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"System key with id 'rushed_fainting' has been rotated\",\n \"data\": {\n \"id\": \"rushed_fainting\",\n \"name\": \"prod_key\",\n \"key\": \"\",\n \"secret\": \"\",\n \"created_at\": \"2023-11-10T19:32:58.646Z\",\n \"expired_at\": \"2024-02-10T19:32:58.646Z\",\n \"permissions\": [\n {\n \"resource_type\": \"USER\",\n \"access_level\": \"READ\"\n },\n {\n \"resource_type\": \"WEBHOOK\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_1\",\n \"group_id_2\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_3\",\n \"connection_id_4\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n }\n ]\n }\n}" } ] } ] }, { "name": "Retrieve System Key Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] }, "description": "Retrieves a system key object within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"rushed_fainting\",\n \"name\": \"updated_key\",\n \"key_value\": \"\",\n \"created_at\": \"2023-10-17T14:01:16.318Z\",\n \"updated_at\": \"2023-10-17T14:02:20.919291Z\",\n \"expired_at\": \"2024-01-17T14:01:16.318Z\",\n \"permissions\": [\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_1\",\n \"group_id_2\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_3\",\n \"connection_id_4\"\n ]\n }\n }\n ]\n }\n}" } ] }, { "name": "Delete a System Key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] }, "description": "Deletes a system key from your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"System key with id 'rushed_fainting' has been deleted\"\n}" } ] }, { "name": "Update a System Key", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"updated_key\",\n \"permissions\": [\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_3\",\n \"group_id_4\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_3\",\n \"connection_id_4\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] }, "description": "Updates an existing system key within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"updated_key\",\n \"permissions\": [\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_3\",\n \"group_id_4\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_3\",\n \"connection_id_4\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/system-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "keyId", "description": "The unique identifier for the system key within your Fivetran account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"System key has been updated\",\n \"data\": {\n \"id\": \"rushed_fainting\",\n \"name\": \"updated_key\",\n \"key_value\": \"\",\n \"created_at\": \"2023-10-17T14:01:16.318Z\",\n \"updated_at\": \"2023-10-17T14:02:20.919291Z\",\n \"expired_at\": \"2024-01-17T14:01:16.318Z\",\n \"permissions\": [\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_3\",\n \"group_id_4\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_3\",\n \"connection_id_4\"\n ]\n }\n }\n ]\n }\n}" } ] } ] }, { "name": "List All System Keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/system-keys?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of system keys within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/system-keys?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"_moonbeam_acc_dev\",\n \"name\": \"dev\",\n \"key\": \"\",\n \"created_at\": \"2023-11-10T22:11:52.326265Z\",\n \"expired_at\": \"2024-02-10T22:11:52.326265Z\"\n },\n {\n \"id\": \"cyclical_prospered\",\n \"name\": \"prod_key\",\n \"key\": \"\",\n \"created_at\": \"2023-11-10T22:11:58.931Z\",\n \"updated_at\": \"2023-11-10T22:11:58.931Z\",\n \"expired_at\": \"2024-02-10T22:11:58.931Z\"\n }\n ]\n }\n}" } ] }, { "name": "Create a System Key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"prod_key\",\n \"expiration_period\": \"THREE_MONTHS\",\n \"permissions\": [\n {\n \"resource_type\": \"USER\",\n \"access_level\": \"READ\"\n },\n {\n \"resource_type\": \"WEBHOOK\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_1\",\n \"group_id_2\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_1\",\n \"connection_id_2\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/system-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys" ] }, "description": "Creates a new system key with your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"prod_key\",\n \"expiration_period\": \"THREE_MONTHS\",\n \"permissions\": [\n {\n \"resource_type\": \"USER\",\n \"access_level\": \"READ\"\n },\n {\n \"resource_type\": \"WEBHOOK\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_1\",\n \"group_id_2\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_1\",\n \"connection_id_2\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/system-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system-keys" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"System key has been created\",\n \"data\": {\n \"id\": \"sod_determine\",\n \"name\": \"prod_key\",\n \"key\": \"\",\n \"secret\": \"\",\n \"created_at\": \"2023-11-10T19:32:58.646Z\",\n \"expired_at\": \"2024-02-10T19:32:58.646Z\",\n \"permissions\": [\n {\n \"resource_type\": \"USER\",\n \"access_level\": \"READ\"\n },\n {\n \"resource_type\": \"WEBHOOK\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"DESTINATION\",\n \"access_level\": \"MANAGE\"\n },\n {\n \"resource_type\": \"TRANSFORMATION\",\n \"access_level\": \"MANAGE\",\n \"resource_filter\": {\n \"group_ids\": [\n \"group_id_1\",\n \"group_id_2\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"NONE\",\n \"resource_filter\": {\n \"ids\": [\n \"connection_id_1\",\n \"connection_id_2\"\n ]\n }\n },\n {\n \"resource_type\": \"CONNECTOR\",\n \"access_level\": \"MANAGE\"\n }\n ]\n }\n}" } ] } ] }, { "name": "teams", "item": [ { "name": "{teamId}", "item": [ { "name": "connections", "item": [ { "name": "{connectionId}", "item": [ { "name": "Retrieve Connection Membership", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections", ":connectionId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns details of a team membership in a connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections", ":connectionId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Team connection membership retrieved successfully\"\n}" } ] }, { "name": "Delete Connection Membership", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections", ":connectionId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Removes team membership in a connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections", ":connectionId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Connection membership has been deleted\"\n}" } ] }, { "name": "Update Connection Membership", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Edit Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections", ":connectionId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Updates team membership in a connection" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Edit Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections", ":connectionId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Connection membership has been updated\"\n}" } ] } ] }, { "name": "List All Connection Memberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Returns all connections a team has membership in." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Team connection memberships retrieved successfully\"\n}" } ] }, { "name": "Add Connection Membership", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"connection_id\",\n \"role\": \"View Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Adds a team as a member of a connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"connection_id\",\n \"role\": \"View Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "connections" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Connection membership has been created\"\n}" } ] } ] }, { "name": "groups", "item": [ { "name": "{groupId}", "item": [ { "name": "Retrieve Group Membership Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups", ":groupId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns details of a team membership in a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups", ":groupId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Team group membership retrieved successfully\"\n}" } ] }, { "name": "Delete Group Membership", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups", ":groupId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Removes a team's membership in a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups", ":groupId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Group membership has been deleted\"\n}" } ] }, { "name": "Update Group Membership", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups", ":groupId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Updates team membership in a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups", ":groupId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Group membership has been updated\"\n}" } ] } ] }, { "name": "List All Group Memberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Returns all groups in which a team has membership." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Team group memberships retrieved successfully\"\n}" } ] }, { "name": "Add Group Membership", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"group_id\",\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Adds a team as a member of a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"group_id\",\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "groups" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Group membership has been created\"\n}" } ] } ] }, { "name": "role", "item": [ { "name": "Delete Team from Account", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/role", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "role" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Removes a team from your Fivetran account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/role", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "role" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Team role in account has been removed\"\n}" } ] } ] }, { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "Retrieve User Membership in a Team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users", ":userId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Returns the membership details for a user in a team." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users", ":userId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-08-20T10:15:20.677566Z\",\n \"role\": \"Team Member\",\n \"user_id\": \"user_id\"\n },\n \"message\": \"Team user details retrieved successfully\"\n}" } ] }, { "name": "Delete a User from a Team", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users", ":userId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Removes a user from a team." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users", ":userId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"User has been removed from the team\"\n}" } ] }, { "name": "Update a User Membership", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Team Member\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users", ":userId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Updates a user membership in a team." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Team Member\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users", ":userId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." }, { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-08-20T10:15:20.677566Z\",\n \"role\": \"Team Member\",\n \"user_id\": \"user_id\"\n },\n \"message\": \"User role has been updated\"\n}" } ] } ] }, { "name": "List All User Memberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users?cursor=cursor_value&limit=100&active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." }, { "key": "active", "value": "true", "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." } ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Returns a list of users and their roles within a team in your Fivetran account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users?cursor=cursor_value&limit=100&active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" }, { "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.", "key": "active", "value": "true" } ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2023-08-20T10:15:20.677566Z\",\n \"role\": \"Team Member\",\n \"user_id\": \"user_id\"\n },\n {\n \"created_at\": \"2023-08-20T10:15:20.677566Z\",\n \"role\": \"Team Member\",\n \"user_id\": \"user_id\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Team users retrieved successfully\"\n}" } ] }, { "name": "Add a User to the Team", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"user_id\",\n \"role\": \"Team Manager\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Assigns a role for a user in a team." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"user_id\",\n \"role\": \"Team Manager\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId", "users" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2023-08-20T10:15:20.677566Z\",\n \"role\": \"Team Member\",\n \"user_id\": \"user_id\"\n },\n \"message\": \"User has been added to the team\"\n}" } ] } ] }, { "name": "Retrieve Team Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Returns information for a given team within your Fivetran account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"team_id\",\n \"role\": \"Account Reviewer\",\n \"name\": \"Team Title\",\n \"description\": \"Team Description\"\n },\n \"message\": \"Team details retrieved successfully\"\n}" } ] }, { "name": "Delete a Team", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Deletes a team from your Fivetran account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams/:teamId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Team has been deleted\"\n}" } ] }, { "name": "Update a Team", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Team Name\",\n \"description\": \"Team description\",\n \"role\": \"Account Analyst\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] }, "description": "Updates information for an existing team within your Fivetran account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Team Name\",\n \"description\": \"Team description\",\n \"role\": \"Account Analyst\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams/:teamId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams", ":teamId" ], "variable": [ { "key": "teamId", "value": "teamId", "description": "The unique identifier for the team within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"team_id\",\n \"role\": \"Account Reviewer\",\n \"name\": \"Team Title\",\n \"description\": \"Team Description\"\n },\n \"message\": \"Team has been updated\"\n}" } ] } ] }, { "name": "List All Teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/teams?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all teams within your Fivetran account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/teams?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"team_id\",\n \"role\": \"Account Reviewer\",\n \"name\": \"Team Title\",\n \"description\": \"Team Description\"\n },\n {\n \"id\": \"team_id\",\n \"role\": \"Account Reviewer\",\n \"name\": \"Team Title\",\n \"description\": \"Team Description\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Teams retrieved successfully\"\n}" } ] }, { "name": "Create a Team", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Team Title\",\n \"description\": \"Team Description\",\n \"role\": \"Account Analyst\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams" ] }, "description": "Creates a new team in your Fivetran account" }, "response": [ { "name": "default response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Team Title\",\n \"description\": \"Team Description\",\n \"role\": \"Account Analyst\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/teams", "host": [ "{{baseUrl}}" ], "path": [ "v1", "teams" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"team_id\",\n \"role\": \"Account Reviewer\",\n \"name\": \"Team Title\",\n \"description\": \"Team Description\"\n },\n \"message\": \"Team has been created\"\n}" } ] } ] }, { "name": "transformation-projects", "item": [ { "name": "{projectId}", "item": [ { "name": "test", "item": [ { "name": "Test Transformation Project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId", "test" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] }, "description": "Triggers tests for an existing transformation project." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId", "test" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"status\": \"NOT_READY\",\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1964-03-12T19:45:18.057Z\",\n \"created_by_id\": \"string\",\n \"group_id\": \"string\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Transformation project test completed successfully\"\n}" } ] } ] }, { "name": "Retrieve Transformation Project Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] }, "description": "Returns transformation project details if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"status\": \"READY\",\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1975-04-08T22:29:28.256Z\",\n \"created_by_id\": \"string\",\n \"group_id\": \"string\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Transformation project details retrieved successfully\"\n}" } ] }, { "name": "Delete Transformation Project", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] }, "description": "Deletes transformation project if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Transformation project with id 'string' has been deleted\"\n}" } ] }, { "name": "Update Transformation Project", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"run_tests\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] }, "description": "Updates transformation project if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"run_tests\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformation-projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "projectId", "description": "The unique identifier for the transformation project within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"status\": \"READY\",\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2017-04-09T08:35:11.845Z\",\n \"created_by_id\": \"string\",\n \"group_id\": \"string\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Transformation project updated successfully\"\n}" } ] } ] }, { "name": "List all Transformation Projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of all transformation projects available via API within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformation-projects?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"created_at\": \"1954-03-24T18:56:45.796Z\",\n \"created_by_id\": \"string\",\n \"group_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"created_at\": \"1988-06-26T10:12:07.234Z\",\n \"created_by_id\": \"string\",\n \"group_id\": \"string\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Transformation projects retrieved successfully\"\n}" } ] }, { "name": "Create Transformation Project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"run_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformation-projects", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects" ] }, "description": "Creates a new transformation project." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"run_tests\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformation-projects", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformation-projects" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"string\",\n \"type\": \"DBT_CORE\",\n \"status\": \"NOT_READY\",\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"1976-09-21T21:58:06.224Z\",\n \"created_by_id\": \"string\",\n \"group_id\": \"string\",\n \"setup_tests\": [\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n },\n {\n \"status\": \"FAILED\",\n \"title\": \"Validate Login\",\n \"message\": \"Invalid login credentials.\",\n \"details\": {}\n }\n ]\n },\n \"message\": \"Transformation project created successfully\"\n}" } ] } ] }, { "name": "transformations", "item": [ { "name": "package-metadata", "item": [ { "name": "{package_definition_id}", "item": [ { "name": "Retrieve a Quickstart Package Metadata Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations/package-metadata/:package_definition_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", "package-metadata", ":package_definition_id" ], "variable": [ { "key": "package_definition_id", "value": "package_definition_id", "description": "The unique identifier for the Quickstart transformation package definition within the Fivetran system" } ] }, "description": "Returns the metadata details of the Quickstart transformation package if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/package-metadata/:package_definition_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", "package-metadata", ":package_definition_id" ], "variable": [ { "key": "package_definition_id", "value": "package_definition_id", "description": "The unique identifier for the Quickstart transformation package definition within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"id\": \"package_definition_id\",\n \"name\": \"package_definition_name\",\n \"version\": \"version\",\n \"connector_types\": [\n \"string\"\n ],\n \"output_model_names\": [\n \"string\",\n \"string\"\n ],\n \"configurable_variables\": {}\n },\n \"message\": \"Transformation package metadata details retrieved successfully\"\n}" }, { "name": "Transformation Package not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/package-metadata/:package_definition_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", "package-metadata", ":package_definition_id" ], "variable": [ { "key": "package_definition_id", "value": "package_definition_id", "description": "The unique identifier for the Quickstart transformation package definition within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Quickstart Package Metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations/package-metadata?service=service&name=service&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", "package-metadata" ], "query": [ { "key": "service", "value": "service", "description": "Specify the service identifier to filter Quickstart packages by connection service" }, { "key": "name", "value": "service", "description": "Specify the package name to filter Quickstart packages by name" }, { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "Returns a list of available Quickstart transformation package metadata details." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/package-metadata?service=service&name=service&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", "package-metadata" ], "query": [ { "description": "Specify the service identifier to filter Quickstart packages by connection service", "key": "service", "value": "service" }, { "description": "Specify the package name to filter Quickstart packages by name", "key": "name", "value": "service" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"package_definition_id\",\n \"name\": \"package_definition_name\",\n \"version\": \"version\",\n \"connector_types\": [\n \"string\"\n ],\n \"output_model_names\": [\n \"string\",\n \"string\"\n ],\n \"configurable_variables\": {}\n },\n {\n \"id\": \"package_definition_id\",\n \"name\": \"package_definition_name\",\n \"version\": \"version\",\n \"connector_types\": [\n \"string\"\n ],\n \"output_model_names\": [\n \"string\",\n \"string\"\n ],\n \"configurable_variables\": {}\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Transformation package metadata list retrieved successfully\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/package-metadata?service=service&name=service&cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", "package-metadata" ], "query": [ { "description": "Specify the service identifier to filter Quickstart packages by connection service", "key": "service", "value": "service" }, { "description": "Specify the package name to filter Quickstart packages by name", "key": "name", "value": "service" }, { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{transformationId}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel Running Transformation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "cancel" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] }, "description": "Cancels the execution of the transformation if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "cancel" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Transformation with id 'string' has been canceled\"\n}" }, { "name": "Transformation not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "cancel" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "run", "item": [ { "name": "Run Transformation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"full_refresh\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/run", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "run" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] }, "description": "Runs the transformation if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"full_refresh\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/run", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "run" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Transformation with id 'string' has been started\"\n}" }, { "name": "Transformation not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"full_refresh\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/run", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "run" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "upgrade", "item": [ { "name": "Upgrade Transformation Package", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/upgrade", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "upgrade" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] }, "description": "Upgrades the Quickstart transformation package to latest version if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/upgrade", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "upgrade" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Transformation package has been upgraded\"\n}" }, { "name": "Transformation Package not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId/upgrade", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId", "upgrade" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve Transformation Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] }, "description": "Returns a transformation details if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-02T00:00:00.743708Z\",\n \"created_by_id\": \"user_id\",\n \"id\": \"transformation_id\",\n \"paused\": true,\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"status\": \"RUNNING\",\n \"type\": \"DBT_CORE\",\n \"last_started_at\": \"2024-01-02T00:00:00.000001Z\",\n \"last_ended_at\": \"2024-01-02T00:00:00.000001Z\",\n \"output_model_names\": [\n \"string\"\n ]\n },\n \"message\": \"Transformation details retrieved successfully\"\n}" }, { "name": "Transformation not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a Transformation", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] }, "description": "Deletes a transformation if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Transformation with id 'string' has been deleted\"\n}" }, { "name": "Transformation not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Transformation", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"paused\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] }, "description": "Updates the transformation if a valid identifier is provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"paused\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-02T00:00:00.743708Z\",\n \"created_by_id\": \"user_id\",\n \"id\": \"transformation_id\",\n \"paused\": true,\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"status\": \"RUNNING\",\n \"type\": \"DBT_CORE\",\n \"last_started_at\": \"2024-01-02T00:00:00.000001Z\",\n \"last_ended_at\": \"2024-01-02T00:00:00.000001Z\",\n \"output_model_names\": [\n \"string\"\n ]\n },\n \"message\": \"Transformation updated successfully\"\n}" }, { "name": "Transformation not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"paused\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations", ":transformationId" ], "variable": [ { "key": "transformationId", "value": "transformationId", "description": "The unique identifier for the transformation within the Fivetran system" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List all Transformations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/transformations?cursor=cursor_value&limit=100&group_id=group_id&project_id=project_id&type=DBT_CORE", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." }, { "key": "group_id", "value": "group_id", "description": "Specify the group identifier to filter transformations by group" }, { "key": "project_id", "value": "project_id", "description": "Specify dbt Core project identifier to filter transformations by project" }, { "key": "type", "value": "DBT_CORE", "description": "Transformation type filter" } ] }, "description": "Returns a list of all transformations within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/transformations?cursor=cursor_value&limit=100&group_id=group_id&project_id=project_id&type=DBT_CORE", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" }, { "description": "Specify the group identifier to filter transformations by group", "key": "group_id", "value": "group_id" }, { "description": "Specify dbt Core project identifier to filter transformations by project", "key": "project_id", "value": "project_id" }, { "description": "Transformation type filter", "key": "type", "value": "DBT_CORE" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-02T00:00:00.743708Z\",\n \"created_by_id\": \"user_id\",\n \"id\": \"transformation_id\",\n \"paused\": true,\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"status\": \"RUNNING\",\n \"type\": \"DBT_CORE\",\n \"last_started_at\": \"2024-01-02T00:00:00.000001Z\",\n \"last_ended_at\": \"2024-01-02T00:00:00.000001Z\",\n \"output_model_names\": [\n \"string\"\n ]\n },\n {\n \"created_at\": \"2024-01-02T00:00:00.743708Z\",\n \"created_by_id\": \"user_id\",\n \"id\": \"transformation_id\",\n \"paused\": true,\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": true\n },\n \"status\": \"RUNNING\",\n \"type\": \"DBT_CORE\",\n \"last_started_at\": \"2024-01-02T00:00:00.000001Z\",\n \"last_ended_at\": \"2024-01-02T00:00:00.000001Z\",\n \"output_model_names\": [\n \"string\"\n ]\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Transformations list retrieved successfully\"\n}" } ] }, { "name": "Create a Transformation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": false\n },\n \"type\": \"DBT_CORE\",\n \"paused\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations" ] }, "description": "Creates a new transformation." }, "response": [ { "name": "Created response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": false\n },\n \"type\": \"DBT_CORE\",\n \"paused\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/transformations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transformations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-02T00:00:00.743708Z\",\n \"created_by_id\": \"user_id\",\n \"id\": \"transformation_id\",\n \"paused\": true,\n \"schedule\": {\n \"schedule_type\": \"TIME_OF_DAY\",\n \"cron\": [\n \"0 */1 * * *\"\n ],\n \"interval\": 60,\n \"days_of_week\": [\n \"MONDAY\",\n \"FRIDAY\"\n ],\n \"time_of_day\": \"14:00\",\n \"connection_ids\": [\n \"connection_id\"\n ],\n \"transformation_ids\": [\n \"transformation_id\"\n ],\n \"smart_syncing\": false\n },\n \"status\": \"RUNNING\",\n \"type\": \"DBT_CORE\",\n \"last_started_at\": \"2024-01-02T00:00:00.000001Z\",\n \"last_ended_at\": \"2024-01-02T00:00:00.000001Z\",\n \"output_model_names\": [\n \"string\"\n ]\n },\n \"message\": \"Transformation created successfully\"\n}" } ] } ] }, { "name": "users", "item": [ { "name": "{id}", "item": [ { "name": "Delete a User", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":id" ], "variable": [ { "key": "id", "value": "user_id", "description": "The unique identifier for the user within the account." } ] }, "description": "Deletes a user from your Fivetran account. You will be unable to delete an account owner user if there is only one remaining." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":id" ], "variable": [ { "key": "id", "value": "user_id", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"User with id 'string' has been deleted\"\n}" }, { "name": "Not found error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":id" ], "variable": [ { "key": "id", "value": "user_id", "description": "The unique identifier for the user within the account." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{userId}", "item": [ { "name": "connections", "item": [ { "name": "{connectionId}", "item": [ { "name": "Retrieve Connection Membership", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Returns the details of a user's membership in a connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"User membership in connection retrieved successfully\"\n}" }, { "name": "User not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete Connection Membership", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Removes user membership in a connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Connection membership has been deleted\"\n}" }, { "name": "User not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update Connection Membership", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] }, "description": "Updates user membership in a connection." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Connection membership has been updated\"\n}" }, { "name": "User not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections", ":connectionId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "connectionId", "value": "4107c213907114059a5544ad8fa66c52", "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)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Connection Memberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Returns all connection membership for a user within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"User memberships in connections retrieved successfully\"\n}" } ] }, { "name": "Add a Connection Membership", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"connection_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Adds a connection membership" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"connection_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Connection membership has been created\"\n}" }, { "name": "User not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"connection_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "connections" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "groups", "item": [ { "name": "{groupId}", "item": [ { "name": "Retrieve Group Membership Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Returns details of a user membership in group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"User membership in group retrieved successfully\"\n}" }, { "name": "User not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete Group Membership", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Removes user from a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Group membership has been deleted\"\n}" }, { "name": "User not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update Group Membership", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "Updates user group membership." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Group membership has been updated\"\n}" }, { "name": "User not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Manage Destination\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups", ":groupId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." }, { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Group Memberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Returns the membership details for all groups a user belongs to." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"User memberships in groups retrieved successfully\"\n}" } ] }, { "name": "Add Group Membership", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"group_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Adds a user membership in a group." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"group_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"id\": \"resource_id\",\n \"role\": \"Role Title\"\n },\n \"message\": \"Group membership has been created\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"group_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "User not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"group_id\",\n \"role\": \"Manage Connection\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "groups" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "role", "item": [ { "name": "Delete Account Role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/role", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "role" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Removes a user's role from an account, but the user remains a member of the account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/role", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "role" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"User role in account has been removed\"\n}" }, { "name": "User not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId/role", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId", "role" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve User Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Returns a user object if a valid identifier was provided." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n },\n \"message\": \"User details retrieved successfully\"\n}" }, { "name": "User not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a User", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"+9876543210\",\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"role\": \"Account Administrator\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Jane\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] }, "description": "Updates information for an existing user within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"+9876543210\",\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"role\": \"Account Administrator\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Jane\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n },\n \"message\": \"User has been updated\"\n}" }, { "name": "User not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"+9876543210\",\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"role\": \"Account Administrator\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Jane\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "userId", "description": "The unique identifier for the user within the account." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List All Users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users?cursor=cursor_value&limit=100&active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." }, { "key": "active", "value": "true", "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." } ] }, "description": "Returns a list of all users within your Fivetran account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/users?cursor=cursor_value&limit=100&active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" }, { "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.", "key": "active", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n },\n {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Users list retrieved successfully\"\n}" } ] }, { "name": "Invite a User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@email.value\",\n \"family_name\": \"Doe\",\n \"given_name\": \"John\",\n \"phone\": \"+1234567890\",\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"role\": \"Account Administrator\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] }, "description": "Invites a new user to your Fivetran account. The invited user will have access to the account only after accepting the invitation. Invited user details are still accessible through the API." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@email.value\",\n \"family_name\": \"Doe\",\n \"given_name\": \"John\",\n \"phone\": \"+1234567890\",\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"role\": \"Account Administrator\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"user@email.value\",\n \"id\": \"user_id\",\n \"logged_in_at\": \"2024-01-01T00:00:00Z\",\n \"role\": \"Account Administrator\",\n \"verified\": true,\n \"invited\": true,\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"phone\": \"+1234567890\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\"\n },\n \"message\": \"User has been created\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@email.value\",\n \"family_name\": \"Doe\",\n \"given_name\": \"John\",\n \"phone\": \"+1234567890\",\n \"picture\": \"AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==\",\n \"role\": \"Account Administrator\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "webhooks", "item": [ { "name": "account", "item": [ { "name": "Create an Account Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"url\": \"https://your-host.your-domain/webhook\",\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "account" ] }, "description": "This endpoint allows you to create a new webhook for the current account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"url\": \"https://your-host.your-domain/webhook\",\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"created_by\": \"user_id\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"id\": \"webhook_id\",\n \"type\": \"group\",\n \"url\": \"https://your-host.your-domain/webhook\",\n \"secret\": \"******\",\n \"group_id\": \"group_id\"\n },\n \"message\": \"Account webhook has been created\"\n}" } ] } ] }, { "name": "group", "item": [ { "name": "{groupId}", "item": [ { "name": "Create a Group Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"url\": \"https://your-host.your-domain/webhook\",\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] }, "description": "This endpoint allows you to create a new webhook for a given group" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"url\": \"https://your-host.your-domain/webhook\",\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"created_by\": \"user_id\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"id\": \"webhook_id\",\n \"type\": \"group\",\n \"url\": \"https://your-host.your-domain/webhook\",\n \"secret\": \"******\",\n \"group_id\": \"group_id\"\n },\n \"message\": \"Group webhook has been created\"\n}" }, { "name": "Group not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"url\": \"https://your-host.your-domain/webhook\",\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "groupId", "description": "The unique identifier for the group within the Fivetran system." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "{webhookId}", "item": [ { "name": "test", "item": [ { "name": "Test a Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"sync_end\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] }, "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" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"sync_end\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"status\": 200,\n \"succeed\": true,\n \"message\": \"Success\"\n },\n \"message\": \"Webhook test completed successfully\"\n}" }, { "name": "Webhook not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"sync_end\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve Webhook Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] }, "description": "This endpoint allows you to retrieve details of the existing webhook for a given identifier" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"created_by\": \"user_id\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"id\": \"webhook_id\",\n \"type\": \"group\",\n \"url\": \"https://your-host.your-domain/webhook\",\n \"secret\": \"******\",\n \"group_id\": \"group_id\"\n },\n \"message\": \"Webhook details retrieved successfully\"\n}" }, { "name": "Webhook not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a Webhook", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] }, "description": "This endpoint allows you to delete an existing webhook with a given identifier" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"message\": \"Webhook with id 'string' has been deleted\"\n}" }, { "name": "Webhook not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a Webhook", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://your-host.your-domain/webhook\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] }, "description": "The endpoint allows you to update the existing webhook with a given identifier" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://your-host.your-domain/webhook\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"created_by\": \"user_id\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"id\": \"webhook_id\",\n \"type\": \"group\",\n \"url\": \"https://your-host.your-domain/webhook\",\n \"secret\": \"******\",\n \"group_id\": \"group_id\"\n },\n \"message\": \"Webhook has been updated\"\n}" }, { "name": "Webhook not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://your-host.your-domain/webhook\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"active\": true,\n \"secret\": \"your_webhook_secret\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "webhookId", "description": "The webhook ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List all Webhooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ], "query": [ { "key": "cursor", "value": "cursor_value", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)" }, { "key": "limit", "value": "100", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100." } ] }, "description": "The endpoint allows you to retrieve the list of existing webhooks available for the current account" }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/webhooks?cursor=cursor_value&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ], "query": [ { "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "key": "cursor", "value": "cursor_value" }, { "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "key": "limit", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"created_by\": \"user_id\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"id\": \"webhook_id\",\n \"type\": \"group\",\n \"url\": \"https://your-host.your-domain/webhook\",\n \"secret\": \"******\",\n \"group_id\": \"group_id\"\n },\n {\n \"active\": true,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"created_by\": \"user_id\",\n \"events\": [\n \"sync_start\",\n \"sync_end\"\n ],\n \"id\": \"webhook_id\",\n \"type\": \"group\",\n \"url\": \"https://your-host.your-domain/webhook\",\n \"secret\": \"******\",\n \"group_id\": \"group_id\"\n }\n ],\n \"next_cursor\": \"cursor_value\"\n },\n \"message\": \"Webhooks retrieved successfully\"\n}" } ] } ] } ] } ], "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{api_secret}}", "type": "string" }, { "key": "username", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.fivetran.com" } ] }