Log Service Management

Our REST API supports the following log service management actions:

Create a Log Service

Creates a new log service within your Fivetran account.

Request

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

{
    "group_id": "string",
    "service": "string",
    "enabled": true,
    "config": {
      "workspace_id": "string",
      "primary_key": "PASSWORD"
    }
}

Payload parameters

Name	Description
`group_id` (required)	The unique identifier of the group within the Fivetran system.
`service` (required)	The name of the log service type within the Fivetran system. Possible log service types.
`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.

Response

HTTP 201 Created

{ 
    "code": "string",
    "message": "string",
    "data": {
      "id": "string",
      "service": "string",
      "enabled": true,
      "config": {
        "workspace_id": "string",
        "primary_key": "PASSWORD"
      }
    }
}

Name	Description
`id`	The unique identifier of the log service within the Fivetran system.
`service`	The name of the log service type within the Fivetran system. Possible log service types.
`enabled`	The boolean value specifying whether the log service is enabled.
`config`	The log service setup configuration. The format is specific for each service.

Retrieve Log Service Details

Retrieves a log service object within your Fivetran account.

Request

GET https://api.fivetran.com/v1/external-logging/{logId}

Query parameters

Name	Description
`logId` (required)	The unique identifier of the log service within your Fivetran account.

Response

HTTP 200 OK

{
    "code": "string",
    "message": "string",
    "data": {
      "id": "string",
      "service": "string",
      "enabled": true,
      "config": {
        "workspace_id": "string",
        "primary_key": "PASSWORD"
      }
    }
}

Name	Description
`id`	The unique identifier of the log service within the Fivetran system.
`service`	The name of the log service type within the Fivetran system. Possible log service types.
`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 Service

Updates information for an existing log service within your Fivetran account.

Request

PATCH https://api.fivetran.com/v1/external-logging/{logId}

{
    "enabled": true,
    "config": {
      "workspace_id": "string",
      "primary_key": "PASSWORD"
    }
}

Path parameters

Name	Description
`logId` (required)	The unique identifier of the log service within your Fivetran account.

Payload parameters

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.

Response

HTTP 200 OK

{
    "code": "string",
    "message": "string",
    "data": {
      "id": "string",
      "service": "string",
      "enabled": true,
      "config": {
        "workspace_id": "string",
        "primary_key": "PASSWORD"
      }
    }
}

Name	Description
`id`	The unique identifier of the log service within the Fivetran system.
`service`	The name of the log service type within the Fivetran system. Possible log service types.
`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 Service

Deletes a log service from your Fivetran account.

Request

DELETE https://api.fivetran.com/v1/external-logging/{logId}

Path parameters

Name	Description
`logId` (required)	The unique identifier of the log service within the Fivetran system.

Response

HTTP 200 OK

{
    "code": "string",
    "message": "string"
}

Run Log Service Setup Tests

Runs the setup tests for an existing log service within your Fivetran account.

Request

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

Path parameters

Name	Description
`logId` (required)	The unique identifier of the log service within the Fivetran system.

Response

HTTP 200 OK

{
    "code": "string",
    "message": "string",
    "data": {
        "setup_tests": [
          {
            "title": "string",
            "status": "string",
            "message": "string"
          }
        ]
    }
}

Name	Description
`setup_tests`	The collection of setup tests executed for the log service.
`title`	The setup test title.
`status`	The status of the test. Possible values: `PASSED`, `SKIPPED`, `WARNING`, `FAILED`, `JOB_FAILED`.
`message`	The additional message.