Try our new Interactive API Reference!
Edit on GitHub
Log Service Managementlink
Our REST API supports the following log service management actions:
- Create a Log Service
- Retrieve Log Service Details
- Update a Log Service
- Delete a Log Service
- Run Log Service Setup Tests
Create a Log Servicelink
Creates a new log service within your Fivetran account.
Requestlink
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "string",
"service": "string",
"enabled": true,
"config": {
...
}
}
content_copyPayload parameterslink
| Name | Description |
|---|---|
group_id (required) | The unique identifier for the group within the Fivetran system. |
service (required) | The name for the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, splunkLog, new_relic_log, stackdriver(Google Cloud Logging). |
enabled | The boolean value specifying whether the log service is enabled. Default value true. |
config (required) | The log service setup configuration. The format is specific for each service. |
Responselink
HTTP 201 Created
{
"code": "string",
"message": "string",
"data": {
"id": "string",
"service": "string",
"enabled": true,
"config": {
...
}
}
}
content_copy| Name | Description |
|---|---|
id | The unique identifier for the log service within the Fivetran system. |
service | The name for the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, splunkLog, new_relic_log, stackdriver(Google Cloud Logging). |
enabled | The boolean value specifying whether the log service is enabled. |
config | The log service setup configuration. The format is specific for each service. |
Log service setup configurationslink
The log service setup configuration (the config field) is different for each log service. The following subsections provide configuration examples for the supported log services to help get you started.
Azure Monitor Loglink
{
"config": {
"workspace_id": "string",
"primary_key": "PASSWORD"
}
}
content_copyAmazon CloudWatchlink
{
"config": {
"log_group_name": "string",
"role_arn": "string",
"external_id": "string",
"region": "string"
}
}
content_copyDatadog Log Managementlink
{
"config": {
"hostname": "string",
"api_key": "PASSWORD",
"region": "EU"
}
}
content_copyGoogle Cloud Logginglink
{
"config": {
"project_id": "string"
}
}
content_copyNew Relic Log Monitoringlink
{
"config": {
"api_key": "PASSWORD",
"sub_domain": "EU"
}
}
content_copySplunk Log Observerlink
{
"config": {
"port": 0,
"host": "string",
"channel": "string",
"enable_ssl": true,
"token": "PASSWORD"
}
}
content_copyRetrieve Log Service Detailslink
Retrieves a log service object within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/external-logging/{logId}
Query parameterslink
| Name | Description |
|---|---|
logId (required) | The unique identifier for the log service within your Fivetran account. |
Responselink
HTTP 200 OK
{
"code": "string",
"message": "string",
"data": {
"id": "string",
"service": "string",
"enabled": true,
"config": {
...
}
}
}
content_copy| Name | Description |
|---|---|
id | The unique identifier for the log service within the Fivetran system. |
service | The name for the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, splunkLog, new_relic_log, stackdriver(Google Cloud Logging). |
enabled | The boolean value specifying whether the log service is enabled. |
config | The log service setup configuration. The format is specific for each service. |
Update a Log Servicelink
Updates information for an existing log service within your Fivetran account.
Requestlink
PATCH https://api.fivetran.com/v1/external-logging/{logId}
{
"enabled": true,
"config": {
...
}
}
content_copyPath parameterslink
| Name | Description |
|---|---|
logId (required) | The unique identifier for the log service within your Fivetran account. |
Payload parameterslink
| Name | Description |
|---|---|
enabled | The boolean value specifying whether the log service is enabled. |
config | The log service setup configuration. The format is specific for each service |
Responselink
HTTP 200 OK
{
"code": "string",
"message": "string",
"data": {
"id": "string",
"service": "string",
"enabled": true,
"config": {
...
}
}
}
content_copy| Name | Description |
|---|---|
id | The unique identifier for the log service within the Fivetran system. |
service | The name for the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, splunkLog, new_relic_log, stackdriver(Google Cloud Logging). |
enabled | The boolean value specifying whether the log service is enabled. |
config | The log service setup configuration. The format is specific for each service. |
Delete a Log Servicelink
Deletes a log service from your Fivetran account.
Requestlink
DELETE https://api.fivetran.com/v1/external-logging/{logId}
Path parameterslink
| Name | Description |
|---|---|
logId (required) | The unique identifier for the log service within the Fivetran system. |
Responselink
HTTP 200 OK
{
"code": "string",
"message": "string"
}
content_copyRun Log Service Setup Testslink
Runs the setup tests for an existing log service within your Fivetran account.
Requestlink
POST https://api.fivetran.com/v1/external-logging/{logId}/test
Path parameterslink
| Name | Description |
|---|---|
logId (required) | The unique identifier for the log service within the Fivetran system. |
Responselink
HTTP 200 OK
{
"code": "string",
"message": "string",
"data": {
"setup_tests": [
{
"title": "string",
"status": "string",
"message": "string"
}
]
}
}
content_copy| Name | Description |
|---|---|
setup_tests | The collection of setup tests executed for the log service. |
title | Setup test title. |
status | Test status. |
message | Additional message. |