Retrieve Log Service Types

Returns all log service types that can be created via API within your Fivetran account. The metadata includes the proper log service name ('Datadog' instead of 'datadog_log'), the log service icon, and links to Fivetran resources.

Request schema

Query parameters

cursor

string

Paging cursor, read more about pagination

example:

cursor_value

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

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

GET /v1/metadata/log-service-types?cursor=cursor_value&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Host: api.fivetran.com

Responses

200

Successful response

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Log service types list retrieved successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

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

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

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Log service types list retrieved successfully",
  "data": {
    "items": [
      {
        "id": "datadog_log",
        "name": "Datadog",
        "type": "Log",
        "description": "Datadog is a monitoring and analytics platform",
        "icons": [
          "string"
        ],
        "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"
      }
    ],
    "next_cursor": "cursor_value"
  }
}