Create Account Log Service

Creates an account-level logging service.

azure_monitor_log

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

service

string

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, dynatrace, grafana_loki, splunkLog, new_relic_log, stackdriver (Google Cloud Logging).

example:

log_service_type

enabled

boolean

The boolean value specifying whether the log service is enabled.

example:

true

config

object

run_setup_tests

boolean

When true, Fivetran runs setup tests immediately after creating or updating the log service and returns the results in the setup_tests field of the response. Defaults to false.

Http + 1.1

POST

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

POST /v1/external-logging/account HTTP/1.1
Accept: application/json
Authorization: Basic 
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 99

{
  "service": "azure_monitor_log",
  "enabled": true,
  "config": {},
  "run_setup_tests": false
}

Responses

201

Successful response

`201`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Account external logging service has been added

data

objectrequired

stringrequired

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

example:

log_id

service

stringrequired

azure_monitor_log

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

setup_tests

array

Results of the most recent setup test run.

title

stringrequired

A human-readable name for the setup test step. For example: Validate Login, Test Connection, Check Permissions.

example:

Validate Login

status

stringrequired

The result of the individual setup test step. Possible values: PASSED, FAILED, SKIPPED.

enum:

"PASSED""SKIPPED""WARNING""FAILED""JOB_FAILED"

message

string

The result message for the setup test step. For example: Invalid login credentials.

example:

Invalid login credentials.

details

object

Additional diagnostic information about the setup test result. Populated when the status is FAILED and more context is available beyond the message.

example:

Authentication failed (401 Unauthorized). Verify the provided credentials and permissions.

config

object

client_id

string

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

example:

your_client_id

client_secret

string

For Logs Ingestion API authentication. Your application client secret.

format:

password

example:

your_client_secret

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

dcr_immutable_id

string

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

example:

dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

dcr_stream_name

string

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

example:

Custom-MyStream_CL

primary_key

string

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

format:

password

example:

your_primary_key

tenant_id

string

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

example:

your_tenant_id

workspace_id

string

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

example:

your_workspace_id

{
  "code": "Success",
  "message": "Account external logging service has been added",
  "data": {
    "id": "log_id",
    "service": "azure_monitor_log",
    "enabled": true,
    "status": {
      "tasks": [
        {
          "code": "reconnect_log",
          "message": "Reconnect Logging Service",
          "details": "Please provide required permissions"
        }
      ],
      "setup_state": "connected"
    },
    "setup_tests": [
      {
        "title": "Validate Login",
        "status": "FAILED",
        "message": "Invalid login credentials.",
        "details": "Authentication failed (401 Unauthorized). Verify the provided credentials and permissions."
      }
    ],
    "config": {
      "client_id": "your_client_id",
      "client_secret": "your_client_secret",
      "data_collection_endpoint": "https://my-endpoint.eastus-1.ingest.monitor.azure.com",
      "dcr_immutable_id": "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "dcr_stream_name": "Custom-MyStream_CL",
      "primary_key": "your_primary_key",
      "tenant_id": "your_tenant_id",
      "workspace_id": "your_workspace_id"
    }
  }
}