Guidewire Cloud Data Access API Configuration Beta

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "guidewire_cloud_data_access",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "schedule": {
    "cron": "0 */6 * * *",
    "interval": 360,
    "schedule_type": "INTERVAL",
    "days_of_week": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "time_of_day": "14:00",
    "time_zone": "Europe/Prague"
  },
  "external_secrets_manager_id": "esm_id",
  "data_checks": true,
  "config": {
    "access_key_id": "access_key_id_value",
    "access_key_secret": "access_key_secret_value",
    "application_path": "application_path",
    "archive_azure_credential": {
      "container_name": "string",
      "prefix": "string",
      "storage_account": "string"
    },
    "archive_gcs_credential": {
      "gcs_bucket": "string",
      "prefix": "string"
    },
    "archive_s3_credential": {
      "prefix": "string",
      "s3_bucket": "string",
      "s3_external_id": "string",
      "s3_role_arn": "string"
    },
    "archive_storage_option": "S3",
    "auth_type": "IAM_ROLE | PUBLIC_BUCKET | ACCESS_KEY",
    "bucket": "bucket_name",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "enable_archive_bucket": true,
    "is_private_link_required": true,
    "role_arn": "arn::your_role_arn",
    "schema": "schema_name"
  },
  "external_secrets_keys_config": {
    "access_key_id": "ACCESS_KEY_ID_KEY",
    "access_key_secret": "ACCESS_KEY_SECRET_KEY"
  }
}

Config parameters

Name	Description
`access_key_id`	Access Key ID for access key authentication.
`access_key_secret`	Access Key Secret for access key authentication.
`application_path`	Path to the CDA application folder relative to the bucket root. Do not include the deployment timestamp folder. Fivetran automatically identifies the active deployment and follows it when Guidewire redeploys CDA.
`archive_azure_credential`	Azure Blob Storage archive settings. Used when `archive_storage_option` is `AZURE`.
`archive_azure_credential.container_name`	Azure Blob container name.
`archive_azure_credential.prefix`	Optional path prefix within the container. Defaults to the root if not set.
`archive_azure_credential.storage_account`	Azure storage account name.
`archive_gcs_credential`	Google Cloud Storage archive settings. Used when `archive_storage_option` is `GCS`.
`archive_gcs_credential.gcs_bucket`	Google Cloud Storage bucket name.
`archive_gcs_credential.prefix`	Optional path prefix within the bucket. Defaults to the root if not set.
`archive_s3_credential`	Amazon S3 archive settings. Used when `archive_storage_option` is `S3`.
`archive_s3_credential.prefix`	Optional path prefix within the bucket. Defaults to the root if not set.
`archive_s3_credential.s3_bucket`	Amazon S3 bucket name.
`archive_s3_credential.s3_external_id`	Fivetran-generated external ID.
`archive_s3_credential.s3_role_arn`	Amazon S3 Role ARN required for authentication.
`archive_storage_option`	Where the archive bucket lives. Supported values: S3, AZURE, GCS. Default value: `S3`.
`auth_type`	Access approach. Supported values: IAM_ROLE, ACCESS_KEY, PUBLIC_BUCKET.
`bucket`	The S3 bucket name containing the Guidewire CDA export. Required for connector creation.
`connection_type`	Connection method. Default value: `Directly`.
`enable_archive_bucket`	Set to `true` to archive a complete copy of the CDA files to your own bucket for long-term retention and resyncs. Default value: `false`.
`is_private_link_required`	Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.
`role_arn`	The Role ARN required for IAM role authentication.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are four ways to authorize this connector type:

IAM role: By specifying the auth_type as "IAM_ROLE" and the values for the role_arn, bucket and application_path parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "guidewire_cloud_data_access",
  "group_id": "group_id",
  "config": {
    "role_arn": "arn::your_role_arn",
    "bucket": "bucket_name",
    "application_path": "application_path",
    "auth_type": "IAM_ROLE"
  }
}

Access key: By specifying the auth_type as "ACCESS_KEY" and the values for the access_key_id, access_key_secret, bucket and application_path parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "guidewire_cloud_data_access",
  "group_id": "group_id",
  "config": {
    "access_key_id": "access_key_id_value",
    "access_key_secret": "access_key_secret_value",
    "bucket": "bucket_name",
    "application_path": "application_path",
    "auth_type": "ACCESS_KEY"
  }
}

Public bucket: By specifying the auth_type as "PUBLIC_BUCKET" and the values for the bucket and application_path parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "guidewire_cloud_data_access",
  "group_id": "group_id",
  "config": {
    "bucket": "bucket_name",
    "application_path": "application_path",
    "auth_type": "PUBLIC_BUCKET"
  }
}

By using the Connect Card or the Fivetran dashboard.