API
Last updated
Last updated
Use this endpoint to send message to HTTP inputs configurations
One or more input config ids
The content type of the message
curl -L \
--request POST \
--url 'https://api-firehose.blip.ai/v1/webhook?firehose-ids=text' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: */*' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'{
"success": true
}OK
Lists the Firehose configs owned by groups of the user
curl -L \
--url '//v1/configs' \
--header 'Authorization: YOUR_API_KEY'[
{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": "[Circular Reference]",
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}
]OK
Gets a Firehose config by its id
The Firehose config id
curl -L \
--url '//v1/configs/{key}' \
--header 'Authorization: YOUR_API_KEY'{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}OK
Deletes a Firehose config by its id
The Firehose config id
curl -L \
--request DELETE \
--url '//v1/configs/{key}' \
--header 'Authorization: YOUR_API_KEY'{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}OK
Inspects an user access token
curl -L \
--url '//v1/auth/inspect-token' \
--header 'Authorization: YOUR_API_KEY'{
"groups": [
{
"access": {
"ANY_ADDITIONAL_PROPERTY": true
},
"attributes": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"clientRoles": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"name": "text",
"path": "text",
"realmRoles": [
"text"
],
"subGroups": [
{
"access": {
"ANY_ADDITIONAL_PROPERTY": true
},
"attributes": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"clientRoles": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"name": "text",
"path": "text",
"realmRoles": [
"text"
],
"subGroups": [
"[Circular Reference]"
]
}
]
}
],
"token": {
"active": true,
"attributes": {},
"aud": [
"text"
],
"auth_time": 1,
"exp": 1,
"iat": 1,
"jti": "text",
"nbf": 1,
"permissions": [
{
"resource_id": "text",
"resource_scopes": [
"text"
],
"rsid": "text",
"rsname": "text",
"scopes": [
"text"
]
}
],
"typ": "text"
},
"user_info": {
"email": "text",
"email_verified": true,
"family_name": "text",
"firehose_access": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"gender": "text",
"given_name": "text",
"middle_name": "text",
"name": "text",
"nickname": "text",
"preferred_username": "text",
"sub": "text",
"updated_at": 1
}
}OK
Adds a new Firehose config
curl -L \
--request POST \
--url '//v1/configs' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}'{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}OK
Verifies a Firehose config
curl -L \
--request POST \
--url '//v1/verify' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"input": {
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"type": "N8N"
}
}'{
"input": {
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"type": "N8N"
}
}OK
Edits a Firehose config by its id
The Firehose config id
curl -L \
--request PUT \
--url '//v1/configs/{key}' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}'{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}OK
Edits some fields from a Firehose config by its id
The Firehose config id
curl -L \
--request PATCH \
--url '//v1/configs/{key}' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"description": "text",
"input": {
"delta_sharing": {
"filter": {
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
}
},
"type": "DELTA_SHARING"
},
"name": "text",
"status": "ACTIVE"
}'{
"description": "text",
"filter": {
"filter": {
"field_name": "",
"filters": [
{
"field_name": "",
"filters": [
"[Circular Reference]"
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
}
],
"op": "AND",
"value": "text",
"value_type": "",
"values": [
"text"
]
},
"groups": [
"text"
],
"indexes": [
"text"
]
},
"id": "text",
"index": [
{
"key": "type",
"required": true,
"value": "text",
"values": [
"text"
]
}
],
"input": {
"allowed_metadata": [
"text"
],
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"input_seed": {
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"parser": {
"mapping": "text"
},
"type": "KAFKA"
},
"prefix": "text",
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"delta_sharing": {
"config": "text",
"file_id": "text",
"filter": {
"bot_field_name": "text",
"bot_field_values": [
"text"
],
"date_field_name": "text",
"since_date_value": "text",
"since_datetime_value": {
"date_value": "text",
"timezone": "text"
},
"tenant_field_name": "text",
"tenant_field_values": [
"text"
],
"until_date_value": "text",
"until_datetime_value": {
"date_value": "text",
"timezone": "text"
}
},
"paging": {
"seconds": 1
},
"period_seconds": 1,
"queries": [
{
"field_name": "text",
"type": "datetime"
}
],
"scheduler": {
"cron": "text",
"seconds": 1
},
"schema": "text",
"share": "text",
"table": "text"
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"subscription": "text"
},
"http_client": {
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"stream": {
"enabled": true,
"reconnect": true,
"scanner": {
"csv": {
"continue_on_error": true,
"custom_delimiter": "text",
"lazy_quotes": true,
"parse_header_row": true
},
"lines": {
"custom_delimiter": "text",
"max_buffer_size": 1
},
"type": "lines"
}
},
"timeout": "text",
"url": "text",
"verb": "GET"
},
"kafka": {
"addresses": [
"text"
],
"consumer_group": "text",
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topics": [
"text"
]
},
"n8n": {
"credentials": [
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"type": "text"
}
],
"firehose_access_token": "text",
"output_error_nodes": [
"text"
],
"output_success_nodes": [
"text"
],
"workflow": {
"connections": {
"ANY_ADDITIONAL_PROPERTY": {
"main": [
[
{
"index": 1,
"node": "text",
"type": "text"
}
]
]
}
},
"id": "text",
"nodes": [
{
"credentials": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"name": "text",
"onError": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"position": [
1
],
"type": "text",
"webhookId": "text"
}
]
}
},
"sql": {
"driver": "mysql",
"query": {
"from": "text",
"group_by": "text",
"having": "text",
"limit": 1,
"order_by": "text",
"select": "text",
"where": "text"
},
"scheduler": {
"cron": "text",
"seconds": 1
},
"uri": "text"
},
"type": "KAFKA"
},
"name": "text",
"output": {
"aws_s3": {
"bucket": "text",
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"region": "text"
},
"azure_blob": {
"container": "text",
"credential": {
"storage_access_key": "text",
"storage_account": "text",
"storage_connection_string": "text",
"storage_sas_token": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"elastic_search": {
"aws": {
"credential": {
"id": "text",
"profile": "text",
"role": "text",
"role_external_id": "text",
"secret": "text",
"token": "text"
},
"endpoint": "text",
"region": "text"
},
"basic_auth": {
"password": "text",
"user_id": "text"
},
"conflict_action": "upsert",
"id_fields": [
"text"
],
"id_separator": "text",
"index": "text",
"pipeline": "text",
"script_params_blobl": {
"mapping": "text"
},
"stored_script": "text",
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"urls": [
"text"
]
},
"email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"to": [
"text"
]
},
"firehose": {
"config_ids": [
"text"
]
},
"google_cloud_pubsub": {
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"project": "text",
"topic": "text"
},
"google_cloud_storage": {
"bucket": "text",
"content_type": "text",
"credential": {
"auth_provider_x509_cert_url": "text",
"auth_uri": "text",
"client_email": "text",
"client_id": "text",
"client_x509_cert_url": "text",
"private_key": "text",
"private_key_id": "text",
"project_id": "text",
"token_uri": "text",
"type": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
}
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"verb": "POST",
"verify_token": "text"
},
"kafka": {
"sasl": {
"mechanism": "NONE",
"password": "text",
"user": "text"
},
"tls": {
"ca_crt": "text",
"client_certs": [
{
"cert": "text",
"key": "text",
"password": "text"
}
],
"enable_renegotiation": true,
"enabled": true,
"root_cas": "text",
"skip_cert_verify": true
},
"topic": "text"
},
"mongodb": {
"collection": "text",
"database": "text",
"uri": "text"
},
"sftp": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"period": ""
},
"sql": {
"driver": "mysql",
"table": {
"name": "text",
"schema": "text"
},
"uri": "text"
},
"target": "text",
"transactional_email": {
"bcc": [
"text"
],
"cc": [
"text"
],
"file": {
"extension": "csv",
"max_size_mb": 1,
"path": "text",
"period": "",
"schema": [
{
"name": "text"
}
],
"separator": "text"
},
"subject": "text",
"template_id": "ALERT",
"to": [
"text"
]
},
"type": "HTTP"
},
"status": "ACTIVE",
"transformer": {
"steps": [
{
"bloblang": {
"mapping": "text"
},
"delete": {
"mapping": "text"
},
"http": {
"basic_auth": {
"password": "text",
"user_id": "text"
},
"body": {
"mapping": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"ignore_error_codes": [
1
],
"oauth": {
"access_token": "text",
"access_token_secret": "text",
"consumer_key": "text",
"consumer_secret": "text"
},
"oauth2": {
"auth_style": "header",
"client_key": "text",
"client_secret": "text",
"endpoint_params": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"scopes": [
"text"
],
"token_type": "bearer",
"token_url": "text"
},
"timeout_seconds": 1,
"url": "text",
"verb": "POST"
},
"id": "text",
"ignore_error": true,
"override": true,
"rate_limit": {
"count": 1,
"interval_seconds": 1
},
"type": "BLOBLANG"
}
],
"workflow": [
[
"text"
]
]
}
}OK
Login as an authenticated user to retrieve the access token
curl -L \
--request POST \
--url '//v1/auth/login' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"password": "text",
"username": "text"
}'{
"access_token": "text",
"expires_in": 1,
"id_token": "text",
"refresh_expires_in": 1,
"refresh_token": "text",
"scope": "text",
"session_state": "text",
"token_type": "text"
}OK
Refresh an user access token
curl -L \
--request POST \
--url '//v1/auth/refresh-token' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"refresh_token": "text"
}'{
"access_token": "text",
"expires_in": 1,
"id_token": "text",
"refresh_expires_in": 1,
"refresh_token": "text",
"scope": "text",
"session_state": "text",
"token_type": "text"
}OK