Retrieve Account Log Service

Returns the account-level logging service if it exists.

azure_monitor_log

Request schema

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/account

GET /v1/external-logging/account 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:

Account external logging service details retrieved successfully

data

objectrequired

stringrequired

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

example:

log_id

service

stringrequired

azure_monitor_log

The name of the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, 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

config

object

data_collection_endpoint

string

For Logs Ingestion API authentication. The endpoint URL for your Data Collection Endpoint.

example:

https://my-endpoint.eastus-1.ingest.monitor.azure.com

workspace_id

string

For HTTP Data Collector API authentication. Your Log Analytics workspace ID.

example:

your_workspace_id

dcr_stream_name

string

For Logs Ingestion API authentication. The stream name of your Data Collection Rule.

example:

Custom-MyStream_CL

tenant_id

string

For Logs Ingestion API authentication. Your Microsoft Entra directory (tenant) ID.

example:

your_tenant_id

dcr_immutable_id

string

For Logs Ingestion API authentication. The immutable ID of your Data Collection Rule.

example:

dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

client_secret

string

For Logs Ingestion API authentication. Your application client secret.

format:

password

example:

your_client_secret

primary_key

string

For HTTP Data Collector API authentication. Your Log Analytics primary key.

format:

password

example:

your_primary_key

client_id

string

For Logs Ingestion API authentication. Your application (client) ID.

example:

your_client_id

{
  "code": "Success",
  "message": "Account external logging service details retrieved successfully",
  "data": {
    "id": "log_id",
    "service": "azure_monitor_log",
    "enabled": true,
    "config": {
      "data_collection_endpoint": "https://my-endpoint.eastus-1.ingest.monitor.azure.com",
      "workspace_id": "your_workspace_id",
      "dcr_stream_name": "Custom-MyStream_CL",
      "tenant_id": "your_tenant_id",
      "dcr_immutable_id": "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "client_secret": "your_client_secret",
      "primary_key": "your_primary_key",
      "client_id": "your_client_id"
    }
  }
}