Airbyte API

https://reference.airbyte.com/reference/
Admin
The Airbyte API enables programmatic control of Airbyte Cloud, allowing users to manage sources,...
Tokens:481,915
Snippets:1,807
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### KYVE Bundle Start ID Examples

Source: https://reference.airbyte.com/reference/patchsource

Examples of comma-separated bundle start IDs.

```text
0
```

```text
0,0
```

--------------------------------

### Start Date Format Example

Source: https://reference.airbyte.com/reference/patchsource

Example of the required YYYY-MM-DD date format for the start date configuration.

```json
"2021-01-01"
```

--------------------------------

### Pinterest Start Date Example

Source: https://reference.airbyte.com/reference/patchsource

Example of the required YYYY-MM-DD date format for the Pinterest source.

```json
"examples": [
              "2022-07-28"
            ]
```

--------------------------------

### Define Date Format Examples

Source: https://reference.airbyte.com/reference/patchsource

Example values for start and end date parameters following the YYYY-MM-DD hh:mm:ss format.

```json
[
  "2022-08-21 16:27:09"
]
```

--------------------------------

### S3 Bucket Configuration Examples

Source: https://reference.airbyte.com/reference/createdestination

Example values for S3 bucket name and path configuration.

```json
"examples": [
  "airbyte_sync"
]
```

```json
"examples": [
  "data_sync/test"
]
```

--------------------------------

### Destination Configuration Example

Source: https://reference.airbyte.com/reference/putdestination

Example JSON object representing a configured destination.

```json
{
          "destinationId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
          "name": "Analytics Team Postgres",
          "destinationType": "postgres",
          "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
        }
```

--------------------------------

### Conversion Window Example

Source: https://reference.airbyte.com/reference/createsource

Example integer value for the conversion_window_days field.

```json
14
```

--------------------------------

### Oracle Destination Configuration Examples

Source: https://reference.airbyte.com/reference/createdestination

Example values for Oracle database port and default schema configuration.

```json
"examples": [
  "1521"
]
```

```json
"examples": [
  "airbyte"
]
```

--------------------------------

### File Source Configuration Examples

Source: https://reference.airbyte.com/reference/patchsource

Examples for configuring reader options and source URLs for file-based data replication.

```json
"examples": [
              "{}",
              "{\"sep\": \" \"}",
              "{\"sep\": \"\\t\", \"header\": 0, \"names\": [\"column1\", \"column2\"] }"
            ]
```

```json
"examples": [
              "https://storage.googleapis.com/covid19-open-data/v2/latest/epidemiology.csv",
              "gs://my-google-bucket/data.csv",
              "s3://gdelt-open-data/events/20190914.export.csv"
            ]
```

--------------------------------

### Glue Database Name Example

Source: https://reference.airbyte.com/reference/patchdestination

Example value for the Glue database name.

```json
"airbyte_database"
```

--------------------------------

### S3-Glue Destination Configuration Examples

Source: https://reference.airbyte.com/reference/listdestinations

Examples for S3 endpoint, path formatting, and serialization library settings.

```json
"examples": [
              "http://localhost:9000"
            ]
```

```json
"examples": [
              "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
            ]
```

```json
"examples": [
              "{date}",
              "{date:yyyy_MM}",
              "{timestamp}",
              "{part_number}",
              "{sync_id}"
            ]
```

```json
"examples": [
              "airbyte_database"
            ]
```

```json
"enum": [
              "org.openx.data.jsonserde.JsonSerDe",
              "org.apache.hive.hcatalog.data.JsonSerDe"
            ]
```

--------------------------------

### GCS Bucket Path Example

Source: https://reference.airbyte.com/reference/putdestination

Example value for the GCS bucket path.

```json
"data_sync/test"
```

--------------------------------

### Azure Blob Storage Configuration Examples

Source: https://reference.airbyte.com/reference/getdestination

Example values for Azure Blob Storage connection parameters.

```json
"blob.core.windows.net"
```

```json
"airbyte5storage"
```

```json
"airbytetestcontainername"
```

```json
"?sv=2016-05-31&ss=b&srt=sco&sp=rwdl&se=2018-06-27T10:05:50Z&st=2017-06-27T02:05:50Z&spr=https,http&sig=bgqQwoXwxzuD2GJfagRg7VOS8hzNr3QLT7rhS8OFRLQ%3D"
```

--------------------------------

### Define Query Examples

Source: https://reference.airbyte.com/reference/patchsource

Example query strings for filtering news articles.

```json
[
  "(Windows 7) AND (Windows 10)",
  "Intel AND (i7 OR i9)"
]
```

--------------------------------

### Define Source Configuration Example

Source: https://reference.airbyte.com/reference/createsource

Example object structure for a source configuration including workspace and source identifiers.

```json
"example": {
          "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
          "name": "Analytics Team Postgres",
          "sourceType": "postgres",
          "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
        }
```

--------------------------------

### Define File Buffer Count Example

Source: https://reference.airbyte.com/reference/patchdestination

Example value for the file buffer count configuration parameter.

```json
"examples": [
  "10"
]
```

--------------------------------

### Start Date Configuration

Source: https://reference.airbyte.com/reference/createsource

Defines the starting point for incremental data replication in ISO 8601 format.

```json
"2017-01-25T00:00:00Z"
```

--------------------------------

### S3 Path Format Example

Source: https://reference.airbyte.com/reference/patchdestination

Example format string for organizing data within an S3 bucket.

```json
"${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
```

--------------------------------

### End Date Example

Source: https://reference.airbyte.com/reference/createsource

Example value for the end_date field in YYYY-MM-DD format.

```json
"2017-01-30"
```

--------------------------------

### Create Workspace via API and SDKs

Source: https://reference.airbyte.com/reference/powered-by-airbyte

Examples for creating a workspace using standard HTTP requests, language-specific SDKs, and infrastructure-as-code.

```python
import requests

url = "https://api.airbyte.com/v1/workspaces"

payload = {"name": "Workspace for Customer X"}
headers = {
    "accept": "application/json",
    "content-type": "application/json",
  	"user-agent": "string",
    "authorization": "Bearer 12345"
}

response = requests.post(url, json=payload, headers=headers)
```

```python
import airbyte
from airbyte.models import shared

s = airbyte.Airbyte(
    security=shared.Security(
        bearer_auth='12345',
    ),
)

req = shared.WorkspaceCreateRequest(
    name='Workspace for Customer X',
)

res = s.workspaces.create_workspace(req)

if res.workspace_response is not None:
    # handle response
```

```java
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"Workspace for Customer X\"}");
Request request = new Request.Builder()
  .url("https://api.airbyte.com/v1/workspaces")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("user-agent", "string")
  .addHeader("authorization", "Bearer 12345")
  .build();

Response response = client.newCall(request).execute();
```

```java
import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateWorkspaceResponse;
import com.airbyte.api.models.shared.Security;
import com.airbyte.api.models.shared.WorkspaceCreateRequest;

public class Application {
    public static void main(String[] args) {
        try {
            Airbyte sdk = Airbyte.builder()
                .setSecurity(new Security("") {{
                    bearerAuth = '12345';
                }})
                .build();

            com.airbyte.api.models.shared.WorkspaceCreateRequest req = new WorkspaceCreateRequest("Workspace for Customer X");            

            CreateWorkspaceResponse res = sdk.workspaces.createWorkspace(req);

            if (res.workspaceResponse != null) {
                // handle response
            }
        } catch (Exception e) {
            // handle exception
        }
    }
}
```

```terraform
terraform {
    required_providers {
    			airbyte = {
        	source = "airbytehq/airbyte"
        	version = "0.1.0"
        }
    }
  
    provider "airbyte" {
        bearer_auth = "12345"
    }
  
  	resource "airbyte_workspace" {
        name = "Workspace for Customer X"
    }
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.airbyte.com/v1/workspaces"

	payload := strings.NewReader("{\"name\":\"Workspace for Customer X\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
  req.Header.Add("user-agent", "string")
	req.Header.Add("authorization", "Bearer 12345")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```javascript
const sdk = require('api')('@airbyte-api/v1#4vsz8clinemryl');

sdk.auth('12345');
sdk.createWorkspace({name: 'Workspace for Customer X'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));
```

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.airbyte.com/v1/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["user-agent"] = 'string'
request["authorization"] = 'Bearer 12345'
request.body = "{\"name\":\"Workspace for Customer X\"}"

response = http.request(request)
puts response.read_body
```

```shell
curl --request POST \
     --url https://api.airbyte.com/v1/workspaces \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'user-agent: string' \
     --header 'authorization: Bearer 12345' \
     --data '
{
  "name": "Workspace for Customer X"
}
'
```

--------------------------------

### GCS Bucket Name Example

Source: https://reference.airbyte.com/reference/putdestination

Example value for the GCS bucket name.

```json
"airbyte_sync"
```

--------------------------------

### S3 Endpoint Example

Source: https://reference.airbyte.com/reference/patchdestination

Example value for the S3 endpoint URL configuration.

```json
"http://localhost:9000"
```

--------------------------------

### Source Creation Request and Response Examples

Source: https://reference.airbyte.com/reference/createsource

Examples of the JSON payload required to create a source and the corresponding response containing the new source ID.

```json
{
  "configuration": {
    "airbyte_source_name": "google-ads",
    "conversion_window_days": 14,
    "customer_id": "1234567890",
    "start_date": 1672531200000,
    "end_date": 1704067200000
  },
  "name": "My Source",
  "workspaceId": "744cc0ed-7f05-4949-9e60-2a814f90c035"
}
```

```json
{
  "sourceId": "0c31738c-0b2d-4887-b506-e2cd1c39cc35"
}
```

--------------------------------

### Timeplus Destination Endpoint Example

Source: https://reference.airbyte.com/reference/listdestinations

Example value for the Timeplus workspace endpoint.

```json
"examples": [
              "https://us.timeplus.cloud/workspace_id"
            ]
```

--------------------------------

### Destination Configuration Update Example

Source: https://reference.airbyte.com/reference/patchdestination

Demonstrates how a partial JSON configuration update affects existing destination settings.

```json
{
  "start_date": "2020-01-01",
  "customer_id": "123456789"
}
```

```json
{
  "customer_id": "abcdefghi"
}
```

--------------------------------

### Define S3 Endpoint Examples

Source: https://reference.airbyte.com/reference/getsource

Example values for the S3 compatible service endpoint.

```json
"examples": [
              "my-s3-endpoint.com",
              "https://my-s3-endpoint.com"
            ]
```

--------------------------------

### KYVE Pool ID Examples

Source: https://reference.airbyte.com/reference/patchsource

Examples of comma-separated pool IDs for KYVE storage.

```text
0
```

```text
0,1
```

--------------------------------

### HMAC Key Secret Example

Source: https://reference.airbyte.com/reference/putdestination

Example value for the HMAC key secret field.

```json
"1234567890abcdefghij1234567890ABCDEFGHIJ"
```

--------------------------------

### Data Freshness Configuration Examples

Source: https://reference.airbyte.com/reference/patchsource

Valid values for the data freshness parameter.

```text
final
```

```text
all
```

--------------------------------

### Databend Port Example

Source: https://reference.airbyte.com/reference/putdestination

Example value for the Databend database port configuration field.

```json
"443"
```

--------------------------------

### S3 Destination Configuration Examples

Source: https://reference.airbyte.com/reference/createdestination

Examples of S3 endpoint URLs, path formatting strings, and filename patterns.

```json
"examples": [
  "http://localhost:9000"
]
```

```json
"examples": [
  "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
]
```

```json
"examples": [
  "{date}",
  "{date:yyyy_MM}",
  "{timestamp}",
  "{part_number}",
  "{sync_id}"
]
```

--------------------------------

### JobsResponse Schema Example

Source: https://reference.airbyte.com/reference/listjobs

Example object representing the structure of a paginated jobs response.

```json
{
  "next": "https://api.airbyte.com/v1/jobs?limit=5&offset=10",
  "previous": "https://api.airbyte.com/v1/jobs?limit=5&offset=0",
  "data": [
    {
      "id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
      "status": "running",
      "jobType": "sync",
      "startTime": "2023-03-25T01:30:50Z"
    }
  ]
}
```

--------------------------------

### JobResponse Schema Example

Source: https://reference.airbyte.com/reference/listjobs

Example object representing the structure of a single job response.

```json
{
  "id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
  "status": "running",
  "jobType": "sync",
  "startTime": "2023-03-25T01:30:50Z",
  "duration": "PT8H6M12S"
}
```

--------------------------------

### API Response Example

Source: https://reference.airbyte.com/reference/powered-by-airbyte

The expected JSON response structure after successfully creating a workspace.

```json
{
  "workspaceId": "9924bcd0-99be-453d-ba47-c2c9766f7da5"
}
```

--------------------------------

### Job List Response Example

Source: https://reference.airbyte.com/reference/listjobs

Example JSON response for a paginated list of jobs.

```json
{
  "next": "https://api.airbyte.com/v1/jobs?limit=5&offset=10",
  "previous": "https://api.airbyte.com/v1/jobs?limit=5&offset=0",
  "data": [
    {
      "id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
      "status": "running",
      "jobType": "sync"
    }
  ]
}
```

--------------------------------

### Google Search Console Site URL Examples

Source: https://reference.airbyte.com/reference/getsource

Examples of website property URLs for the Google Search Console source configuration.

```json
"https://example1.com/",
"sc-domain:example2.com"
```

--------------------------------

### Custom GAQL Query Example

Source: https://reference.airbyte.com/reference/createsource

Example of a custom GAQL query string for the custom_queries_array field.

```json
"SELECT segments.ad_destination_type, campaign.advertising_channel_sub_type FROM campaign WHERE campaign.status = 'PAUSED'"
```

--------------------------------

### Sync Data via HTTP and SDKs

Source: https://reference.airbyte.com/reference/powered-by-airbyte

Examples for triggering a sync job using various programming languages and the Airbyte SDK.

```python
import requests

url = "https://api.airbyte.com/v1/jobs"

payload = {
    "jobType": "sync",
    "connectionId": "9924bcd0-99be-453d-ba47-c2c9766f7da5"
}
headers = {
    "accept": "application/json",
    "content-type": "application/json",
  	"user-agent": "string",
    "authorization": "Bearer 12345"
}

response = requests.post(url, json=payload, headers=headers)
```

```python
import airbyte
from airbyte.models import shared

s = airbyte.Airbyte(
    security=shared.Security(
        bearer_auth="12345",
    ),
)

req = shared.JobCreateRequest(
    connection_id='9924bcd0-99be-453d-ba47-c2c9766f7da5',
    job_type=shared.JobTypeEnum.SYNC,
)

res = s.jobs.create_job(req)

if res.job_response is not None:
    # handle response
```

```java
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"jobType\":\"sync\",\"connectionId\":\"9924bcd0-99be-453d-ba47-c2c9766f7da5\"}");
Request request = new Request.Builder()
  .url("https://api.airbyte.com/v1/jobs")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("user-agent", "string")
  .addHeader("authorization", "Bearer 12345")
  .build();

Response response = client.newCall(request).execute();
```

```java
import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateJobResponse;
import com.airbyte.api.models.shared.JobCreateRequest;
import com.airbyte.api.models.shared.JobTypeEnum;
import com.airbyte.api.models.shared.Security;

public class Application {
    public static void main(String[] args) {
        try {
            Airbyte sdk = Airbyte.builder()
                .setSecurity(new Security("") {{
                    bearerAuth = "12345";
                }})
                .build();

            com.airbyte.api.models.shared.JobCreateRequest req = new JobCreateRequest("9924bcd0-99be-453d-ba47-c2c9766f7da5", JobTypeEnum.SYNC);            

            CreateJobResponse res = sdk.jobs.createJob(req);

            if (res.jobResponse != null) {
                // handle response
            }
        } catch (Exception e) {
            // handle exception
        }
    }
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.airbyte.com/v1/jobs"

	payload := strings.NewReader("{\"jobType\":\"sync\",\"connectionId\":\"9924bcd0-99be-453d-ba47-c2c9766f7da5\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
  req.Header.Add("user-agent", "string")
	req.Header.Add("authorization", "Bearer 12345")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```javascript
const sdk = require('api')('@airbyte-api/v1#dahs1vlfu9tyt2');

sdk.auth('12345');
sdk.createJob({jobType: 'sync', connectionId: '9924bcd0-99be-453d-ba47-c2c9766f7da5'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));
```

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.airbyte.com/v1/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["user-agent"] = 'string'
request["authorization"] = 'Bearer 12345'
request.body = "{\"jobType\":\"sync\",\"connectionId\":\"9924bcd0-99be-453d-ba47-c2c9766f7da5\"}"

response = http.request(request)
puts response.read_body
```

```shell
curl --request POST \
     --url https://api.airbyte.com/v1/jobs \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'user-agent: string' \
     --header 'authorization: Bearer 12345' \
     --data '
{
  "jobType": "sync",
  "connectionId": "9924bcd0-99be-453d-ba47-c2c9766f7da5"
}
'
```

--------------------------------

### Astra DB Endpoint Example

Source: https://reference.airbyte.com/reference/putdestination

Example value for the Astra DB endpoint configuration field.

```json
"https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com"
```

--------------------------------

### Example JSON for Destination Configuration Update

Source: https://reference.airbyte.com/reference/putdestination

Use this structure to pass configuration values, ensuring secret fields are set to "**********" to maintain existing values.

```json
{
  "credentials": {
    "client_id": "**********",
    "client_secret": "**********",
    "refresh_token": "**********"
  },
  "other_configuration": "value",
  ...
}
```
Tokens:
Raw