Capability Library · Pack detail

fivetran v1.0.0

Fivetran REST API: read destinations, connector metadata and connections, update a connection's schedule, trigger and historically re-sync connection data, and delete connections.

Review state: draft· Not in the distributable release manifest

Release identity

SHA-256 of the pack file bytes: 200c8bf9dbd3a036bf596dc3ce5fafd39242be46e86fecd1cecc3c8f98109e01

Not in the distributable release manifest. The binary carries a digest-bound manifest of the distributable library; a pack whose bytes differ from its manifest entry — endpoint, tier, allowlist, or credential edited, with provider, version, and review block preserved — fails the digest check, loses distributability, and renders MODIFIED rather than as the shipped reviewed artifact. Review state and artifact status are different facts: the first is a documentation-review declaration, the second is the identity of the exact bytes.

Capabilities (7)

fivetran.destinations.read v1.0.0R0

Action
read
Endpoint
GET https://fivetran-api.invalid/v1/destinations
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

List the account's destinations; this pack registers the collection read only — single-destination reads are not registered. Destination records reveal where the organization lands its replicated data (service, region, group ids), which is internal infrastructure information. The host is a reserved placeholder: substitute api.fivetran.com before enabling.

fivetran.metadata.connectors.read v1.0.0R0

Action
read
Endpoint
GET https://fivetran-api.invalid/v1/metadata/connector-types
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

List the available connector types and their internal service identifiers and configuration schemas — vendor catalog information used to build connection requests, registered at the internal class because the response drives downstream provisioning decisions. The registered path is the current '/v1/metadata/connector-types' shown on the fetched metadata-connectors reference page (the legacy '/v1/metadata/connectors' path was sunset in 2022). The host is a reserved placeholder: substitute api.fivetran.com before enabling.

fivetran.connections.read v1.0.0R0

Action
read
Endpoint
GET https://fivetran-api.invalid/v1/connections
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

List the account's connections (List All Connections); this pack registers the collection read only — Retrieve Connection Details (GET /v1/connections/{connectionId}) is deliberately not registered because the fetched connection-details page's response example echoes a credential-valued config field — the example does not prove live responses return unmasked secrets, but the detail response must be treated as credential-bearing until proven otherwise, and a read that may return live secrets needs a response-handling review this pack has not done. Connection records reveal which systems replicate into which destination, their schedules and their sync state — internal pipeline information. The host is a reserved placeholder: substitute api.fivetran.com before enabling.

fivetran.connection.update v1.0.0R3

Actions
update, deploy
Endpoint
PATCH https://fivetran-api.invalid/v1/connections/CONNECTION_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

Update one connection's mutable fields — pausing and resuming (paused), the scheduling method (schedule_type auto or manual; setting manual makes every subsequent sync occur only through an explicit trigger call), the sync frequency and the networking settings. Resuming a paused connection or setting schedule_type to auto re-enables provider-side execution: Fivetran's scheduler then moves customer data on its own without traversing fivetran.connection.sync.trigger, so the update carries the deploy-class effect and the capability declares update and deploy at the R3 floor. This registration does not restrict which fields the request body may carry: the body can also carry config values, which for many services are source credentials, so a request body can itself contain live secrets and must be handled like one. A reviewer who intends pause-only must impose that in policy, because an installer's intention is not a restriction. CONNECTION_ID is a placeholder the deployment binds before enabling.

fivetran.connection.sync.trigger v1.0.0R3

Actions
deploy, delete
Endpoint
POST https://fivetran-api.invalid/v1/connections/CONNECTION_ID/sync
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

Trigger a data sync for one connection without waiting for its schedule. Registered with the deploy action at the R3 floor rather than as an ordinary execution: the sync moves customer data from the source system into the destination, overwriting destination state, and that data movement cannot be un-moved by a later call. Deploy is one of the IRREVERSIBLE ACTIONS (delete, send, pay, deploy, approve, share and transfer) and an irreversible action cannot be taken without a person. Body-shape note: the documented body is {"force": true|false}; the fetched sync-connection page confirms force=true 'will stop the sync and re-run it' — terminating an in-flight sync is a terminate-class, irreversible interruption (the interrupted sync's partial work is not rolled back), so the delete verb is declared alongside deploy; an empty body syncs only if the connection is idle. The registration does not restrict the body, so the interrupt-in-flight behavior is in scope. CONNECTION_ID is a placeholder the deployment binds before enabling.

fivetran.connection.resync v1.0.0R3

Action
deploy
Endpoint
POST https://fivetran-api.invalid/v1/connections/CONNECTION_ID/resync
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

Trigger a full historical re-sync of a connection. Registered with the deploy action at the R3 floor: a re-sync re-reads the source from the beginning and rewrites the destination tables — heavier than a sync on both the source system (full re-extract) and the destination (rewritten tables), and it cannot be un-run. Deploy is one of the IRREVERSIBLE ACTIONS. Body-shape note: the documented body is an optional scope object mapping schema names to non-empty arrays of table names; omitting it re-syncs every schema and table of the connection, which is the default a caller gets with an empty body. The API declines with 409 while another sync is in progress and re-syncs a paused connection when it is re-enabled — documented timing behaviors, not restrictions this pack imposes. CONNECTION_ID is a placeholder the deployment binds before enabling.

fivetran.connection.delete v1.0.0R3

Action
delete
Endpoint
DELETE https://fivetran-api.invalid/v1/connections/CONNECTION_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-fivetran-api-key
Data class
internal

Delete a connection from the Fivetran account. The pipeline definition — source configuration, sync cursor, schedule — is removed; recreating the connection later starts as a new pipeline (a new initial sync), not an undo of this call, and any downstream models or dashboards fed by the connection stop updating. Registered as delete at the R3 floor; delete is one of the IRREVERSIBLE ACTIONS (delete, send, pay, deploy, approve, share and transfer). CONNECTION_ID is a placeholder the deployment binds before enabling.

Credential reference

The pack names a reference, never a secret. Installing a pack registers capabilities and makes them governable; registration is not connectivity. The credential is created at the provider and held in the client's own secret manager under the reference the pack names, and deployment testing is still required to show the credential path works and cannot be bypassed.

Reference
secret-ref-fivetran-api-key
Custody
customer_vault
Injection
header (Authorization)

A Fivetran API key-secret pair, held in the client's own secret manager. The stored material must be the complete Authorization header value: the scheme 'Basic', one separating space, then the base64 of 'api_key:api_secret' — 'Basic <base64(api_key:api_secret)>'. Token issuance is external and manual: a key is generated in the Fivetran dashboard (username > API Key), and Fivetran shows the secret only once at generation; the deployment stores the encoded header value under this reference and the executor injects it verbatim — the injector performs no key lifecycle itself. A scoped API key is tied to the Fivetran user who generated it and inherits that user's RBAC permissions, tracking any later permission changes: generate the key from a dedicated least-privilege service user whose role covers only the groups and operations this pack registers (Fivetran also documents organization-managed System keys and, in private preview, service-account keys — either is preferable to a personal user's key where the plan supports it). Expiry and revocation: the pair does not expire on its own; regenerating the API secret instantly invalidates the old key-secret pair, and deleting the owning user deletes and revokes the key — because every request is authenticated against the key, revocation takes effect on the next call and there is no already-issued token that outlives it. An invalid pair fails closed with a 401. Executor hygiene: the value must live only in executor memory for the lifetime of a call, must never be written to logs, traces or diagnostics, and must not appear in crash dumps; a deployment that cannot meet that bar must not enable the pack.

Resources

  • fivetran-account (api, internal): https://fivetran-api.invalid/v1

Pack notes and exclusions

The endpoint host 'fivetran-api.invalid' is a reserved non-production placeholder (an RFC 2606 reserved TLD): substitute Fivetran's real API host api.fivetran.com before enabling, in every endpoint, in the resource locator and in every egress allowlist entry — the allowlist matches exactly, so all three must be substituted together, and substitution is a required deployment step. The placeholder stands in for a single global API host that serves every Fivetran account (there is no per-tenant hostname); the account scoping comes from the API key, not the host. CONNECTION_ID in the paths is a placeholder the deployment binds to a concrete connection before enabling. Naming and versioning: Fivetran renamed 'connectors' to 'connections' in the current REST API; this pack registers the current /v1/connections/... paths (the legacy /v1/connectors/... aliases still serve the same operations but are not registered). The current API negotiates version 2 through the Accept header (application/json;version=2); the documented examples set it, and how the HTTP connector pins that header is a deployment binding decision — the registration records the endpoint, and a response rendered under a different negotiated version is a compatibility review, not a different capability. Tiering rationale: sync and re-sync are registered with the deploy action at the R3 floor rather than as ordinary executions — a sync moves customer data from source systems into the destination, and a historical re-sync re-reads the source and rewrites destination tables, so both are data-movement operations whose blast radius is the connected systems; deploy is one of the IRREVERSIBLE ACTIONS (delete, send, pay, deploy, approve, share and transfer). Documented exclusions — this pack does not register: connection creation (POST /v1/connections), because its config/auth payload embeds the source system's credentials and writing third-party secrets through a governed capability needs its own credential-handling review; Retrieve Connection Details (GET /v1/connections/{connectionId}), because the fetched connection-details page's response EXAMPLE echoes a credential-valued config field (api_key) — the example does not prove live responses return unmasked secrets, but the response must be treated as credential-bearing until proven otherwise, and a read that may return live secrets is excluded until the deployment demonstrates log and trace hygiene for response bodies (the collection read is registered instead); Move a Connection (POST /v1/connections/{connectionId}/move), whose BACKFILL and CONTINUE_WITH_DATA behaviors copy or rewrite data between destinations — transfer-class semantics requiring a separate review; the connection schema configuration endpoints (including PATCH schema/table/column config and drop-columns, which deletes columns from the destination); Run Connection Setup Tests; and the rest of the account-administration surface — users, teams, roles, system keys, certificates, external secrets managers, hybrid deployment agents, private links and webhooks (destination WRITES stay excluded; destination listing is registered above) — none of which the integration this pack models requires. A documented exclusion, not an approximated capability.

Review record

Draft review record dated 2026-09-21 · Reviewer: aaes-eng (an opaque id that resolves internally to the responsible reviewer)

A pack review is not a vendor or examiner attestation. A retrieval date says when a source page was read; it does not by itself establish what the page said then. No pack is vendor-endorsed, and none has been connectivity-tested against a live vendor tenant.