Retrieve Log Service Type Metadata

Returns metadata of configuration parameters for a specified log service type.

Request schema

Path parameters

service

stringrequired

The log service type identifier within the Fivetran system

example:

datadog_log

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/metadata/log-service-types/datadog_log

GET /v1/metadata/log-service-types/datadog_log HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Host: api.fivetran.com

Responses

200

Successful response

404

Log service type not found

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Log service configuration retrieved successfully

data

objectrequired

stringrequired

The log service type identifier within the Fivetran system

example:

datadog_log

name

stringrequired

The log service name within the Fivetran system

example:

Datadog

type

stringrequired

The log service type

enum:

"Log"

description

string

The description characterizing the purpose of the log service

example:

Datadog is a monitoring and analytics platform

icons

array

The set of additional icon resource URLs in different formats (.svg, .png). Updating this list is not a breaking change. The set of icon URLs or the icons themselves may be changed

type:

string

config

object

Metadata for configuration fields. Returned only by the endpoint for a specified log service type

icon_url

string

The icon resource URL

example:

https://fivetran.com/integrations/datadog_log/resources/datadog.png

link_to_docs

string

The link to the log service documentation

example:

https://fivetran.com/docs/logs/datadog

service_status

string

The current availability status of the log service

enum:

"general_availability""beta""private_preview""sunset""development"

service_status_updated_at

string

The date (yyyy-MM-dd) the log service status was updated to the current availability status

format:

date-time

{
  "code": "Success",
  "message": "Log service configuration retrieved successfully",
  "data": {
    "id": "datadog_log",
    "name": "Datadog",
    "type": "Log",
    "description": "Datadog is a monitoring and analytics platform",
    "icons": [
      "string"
    ],
    "config": {},
    "icon_url": "https://fivetran.com/integrations/datadog_log/resources/datadog.png",
    "link_to_docs": "https://fivetran.com/docs/logs/datadog",
    "service_status": "general_availability",
    "service_status_updated_at": "2019-08-24T14:15:22Z"
  }
}