Atlassian Compass API Configuration Lite

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": "atlassian_compass",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "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",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "api_token": "your_atlassian_compass_api_token",
    "email_id": "your_atlassian_compass_email_id",
    "sub_domain": "your_atlassian_compass_subdomain",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`api_token`	Your Atlassian Compass API token.
`email_id`	The email ID associated with the Atlassian Compass account you want Fivetran to use to access your data.
`sub_domain`	Your Atlassian Compass subdomain.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the email_id, api_token and sub_domain parameters in the request.

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

{
  "service": "atlassian_compass",
  "group_id": "group_id",
  "config": {
    "email_id": "your_atlassian_compass_email_id",
    "api_token": "your_atlassian_compass_api_token",
    "sub_domain": "your_atlassian_compass_subdomain"
  }
}

By using the Connect Card or the Fivetran dashboard.