List All Log Services within Account

Returns a list of all accessible logging services within your Fivetran account.

Request schema

Query parameters

cursor

string

Paging cursor, read more about pagination

example:

cursor_value

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/external-logging

GET /v1/external-logging?cursor=cursor_value&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

External logging services retrieved successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

stringrequired

The unique identifier for the log service within the Fivetran system.

example:

log_id

service

stringrequired

The name of the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, dynatrace, grafana_loki, splunkLog, new_relic_log, stackdriver (Google Cloud Logging).

example:

log_service_type

enabled

booleanrequired

The boolean value specifying whether the log service is enabled.

example:

true

status

object

Setup status of the log service. Present when a setup status exists for the log service.

tasks

array

List of alerts describing issues with the log service configuration.

code

string

Alert code identifying the type of issue.

example:

reconnect_log

message

string

Human-readable description of the issue.

example:

Reconnect Logging Service

details

string

Additional context or details for the alert.

example:

Please provide required permissions

setup_state

string

Current setup state of the log service. Possible values: connected — log service is reachable and forwarding events; broken — configuration errors prevent log delivery; incomplete — setup has not been completed and log delivery is paused. Example: connected.

example:

connected

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "External logging services retrieved successfully",
  "data": {
    "items": [
      {
        "id": "log_id",
        "service": "log_service_type",
        "enabled": true,
        "status": {
          "tasks": [
            {
              "code": "reconnect_log",
              "message": "Reconnect Logging Service",
              "details": "Please provide required permissions"
            }
          ],
          "setup_state": "connected"
        }
      }
    ],
    "next_cursor": "cursor_value"
  }
}