Run an Airbyte sync.
type: "io.kestra.plugin.airbyte.connections.Sync"
Examples
id: airbyte_sync
namespace: company.team
tasks:
- id: sync
type: io.kestra.plugin.airbyte.connections.Sync
url: http://localhost:8080
connectionId: e3b1ce92-547c-436f-b1e8-23b6936c12cd
Trigger a single Airbyte sync on schedule
id: airbyte_sync
namespace: company.team
tasks:
- id: data_ingestion
type: io.kestra.plugin.airbyte.connections.Sync
connectionId: e3b1ce92-547c-436f-b1e8-23b6936c12ab
url: http://host.docker.internal:8000/
username: "{{ secret('AIRBYTE_USERNAME') }}"
password: "{{ secret('AIRBYTE_PASSWORD') }}"
triggers:
- id: every_minute
type: io.kestra.plugin.core.trigger.Schedule
cron: "*/1 * * * *"
Properties
connectionId *Requiredstring
The connection ID to sync.
url *Requiredstring
The URL of your Airbyte instance.
applicationCredentials Non-dynamicAbstractAirbyteConnection-ApplicationCredentials
Application credentials.
Applications allow you to generate tokens to access the Airbyte API.
failOnActiveSync booleanstring
true
Specify whether task should fail if a sync is already running.
httpTimeout string
PT10S
duration
HTTP connection timeout.
maxDuration string
PT1H
duration
The maximum total wait duration.
options Non-dynamicHttpConfiguration
The HTTP client configuration.
password string
Basic authentication password.
pollFrequency string
PT1S
duration
Specify frequency for sync attempt state check API call.
token string
API key.
username string
Basic authentication username.
wait booleanstring
true
Wait for the job to end.
Allowing capture of job status & logs.
Outputs
alreadyRunning boolean
Whether a sync was already running.
jobId integer
The job ID created.
Definitions
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeout string
duration
The time allowed to establish a connection to the server before failing.
readIdleTimeout string
PT5M
duration
The time allowed for a read connection to remain idle before closing it.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type *Requiredobject
password string
The password for HTTP basic authentication.
username string
The username for HTTP basic authentication.
java.nio.charset.Charset
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailed booleanstring
false
If true, allow a failed response code (response code >= 400)
allowedResponseCodes array
List of response code allowed for this request
auth BasicAuthConfigurationBearerAuthConfiguration
The authentification to use.
defaultCharset Charsetstring
UTF-8
The default charset for the request.
followRedirects booleanstring
true
Whether redirects should be followed automatically.
logs array
REQUEST_HEADERS
REQUEST_BODY
RESPONSE_HEADERS
RESPONSE_BODY
The enabled log.
proxy ProxyConfiguration
The proxy configuration.
ssl SslOptions
The SSL request options
timeout TimeoutConfiguration
The timeout configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
address string
The address of the proxy server.
password string
The password for proxy authentication.
port integerstring
The port of the proxy server.
type string
DIRECT
DIRECT
HTTP
SOCKS
The type of proxy to use.
username string
The username for proxy authentication.
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificates booleanstring
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
io.kestra.plugin.airbyte.AbstractAirbyteConnection-ApplicationCredentials
clientId *Requiredstring
Client ID.
clientSecret *Requiredstring
Client Secret.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type *Requiredobject
token string
The token for bearer token authentication.