Log Service Metadata

Represents the metadata for a log service type that you can create through the API. The log service metadata resource provides static information about a log service type's identity and configuration schema. It is useful for discovering which log service types are available and which configuration fields each one accepts before you create a log service.

Resource attributes

The following attributes describe a log service type.

View attribute definitions

Log service metadata attributes

Field name	Type	Description
`id`	string, read-only	Unique identifier of the log service type within the Fivetran system. Example: `datadog_log`.
`name`	string, read-only	Public name of the log service type. Example: `Datadog Log`.
`type`	string, read-only	Category of the service. Always `Log`.
`description`	string, read-only	A short description of the log service type's purpose.
`icon_url`	string, read-only	URL of the log service type's icon image.
`icons`	array of strings, read-only	Set of icon URLs in multiple formats (PNG and SVG).
`link_to_docs`	string, read-only	URL to the log service type's documentation page.
`service_status`	string, read-only	Availability status of the log service type. Possible values: `general_availability` – Available to all customers. `beta` – Available but still in beta. `private_preview` – Available to select customers only. `sunset` – No longer available.
`service_status_updated_at`	string, read-only	Date the log service type's availability status was last updated, in `yyyy-MM-dd` format.
`config`	object, read-only	JSON schema describing the log service type's configuration fields. Returned only when you retrieve a single log service type. See Config schema.

Config schema

The config object lists the configuration fields of the log service type in its properties object. Each field has the following attributes.

Field name	Type	Description
`type`	string	Data type of the field.
`format`	string	Present for fields that hold secrets, such as API keys. The value is `password`.
`enum`	array of strings	Present for fields that accept a fixed set of values. Lists the allowed values.
`readonly`	boolean	If `true`, the field is read-only: you can't set or change it.
`immutable`	boolean	If `true`, you can set the field only when you create the log service.
`nullable`	boolean	If `true`, you can clear the field by sending `null`.
`fieldStatus`	string	Availability status of the field.

Supported operations

Category	Endpoint	Description
Read	- `GET /v1/metadata/log-service-types` - `GET /v1/metadata/log-service-types/{service}`	- Returns a paginated list of the log service types you can create and their metadata. - Returns the metadata for a specific log service type, including its full configuration schema.