Run Group Log Service Setup Tests

Runs the setup tests for an existing group-level logging service within your Fivetran account.

Request schema

Path parameters

logId

stringrequired

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

example:

logId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

POST

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

POST /v1/external-logging/logId/test 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:

Setup tests have been completed

data

objectrequired

setup_tests

array

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.

{
  "code": "Success",
  "message": "Setup tests have been completed",
  "data": {
    "setup_tests": [
      {
        "title": "Validate Login",
        "status": "FAILED",
        "message": "Invalid login credentials.",
        "details": "Authentication failed (401 Unauthorized). Verify the provided credentials and permissions."
      }
    ]
  }
}