Anaplan API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "anaplan",
"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
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"sync_mode": "AllExports | SpecificExports",
"password": "password",
"selected_exports": [
"string"
],
"certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
"auth_mode": "Basic | Certificate",
"private_key": "your_api_secret",
"region": "string",
"username": "username",
"schema": "schema_name"
}
}
Config parameters
Name | Description |
---|---|
sync_mode | Whether to sync all exports or specific exports. |
password | Your Anaplan password. Must be populated if auth_mode is set to Basic . |
selected_exports | The list of export IDs in the format <workspace_id>_<model_id>_<export_id> that the connector will sync. Must be populated if sync_mode is set to SpecificExports . |
certificate | The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate . |
auth_mode | The Anaplan authentication method. |
private_key | The contents of your private key file. Must be populated if auth_mode is set to Certificate . |
region | Your Anaplan account region |
username | Your Anaplan user ID. Must be populated if auth_mode is set to Basic . |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are three ways to authorize this connector type:
Basic: By specifying the
auth_mode
as"Basic"
and the values for theusername
andpassword
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "anaplan", "group_id": "group_id", "config": { "username": "username", "password": "password", "auth_mode": "Basic" } }
Certificate: By specifying the
auth_mode
as"Certificate"
and the values for thecertificate
andprivate_key
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "anaplan", "group_id": "group_id", "config": { "certificate": "xxxxx-xxxxx-xxxxx-xxxxx", "private_key": "your_api_secret", "auth_mode": "Certificate" } }
By using the Connect Card or the Fivetran dashboard.