Langfuse JS/TS SDKs
    Preparing search index...

    Interface CreateBlobStorageIntegrationRequest

    interface CreateBlobStorageIntegrationRequest {
        accessKeyId?: string;
        bucketName: string;
        compressed?: boolean;
        enabled: boolean;
        endpoint?: string;
        exportFieldGroups?: BlobStorageExportFieldGroup[];
        exportFrequency: BlobStorageExportFrequency;
        exportMode: BlobStorageExportMode;
        exportSource?: BlobStorageExportSource;
        exportStartDate?: string;
        fileType: BlobStorageIntegrationFileType;
        forcePathStyle: boolean;
        prefix?: string;
        projectId: string;
        region: string;
        secretAccessKey?: string;
        type: BlobStorageIntegrationType;
    }
    Index

    Properties

    accessKeyId? bucketName compressed? enabled endpoint? exportFieldGroups? exportFrequency exportMode exportSource? exportStartDate? fileType forcePathStyle prefix? projectId region secretAccessKey? type

    Properties

    accessKeyId?: string

    Access key ID for authentication

    bucketName: string

    Name of the storage bucket. For AZURE_BLOB_STORAGE, must be a valid Azure container name (3-63 chars, lowercase letters, numbers, and hyphens only, must start and end with a letter or number, no consecutive hyphens).

    compressed?: boolean

    Enable gzip compression for exported files (.csv.gz, .json.gz, .jsonl.gz). Defaults to true.

    enabled: boolean

    Whether the integration is active

    endpoint?: string

    Custom endpoint URL (required for S3_COMPATIBLE type)

    exportFieldGroups?: BlobStorageExportFieldGroup[]

    Field groups to include in each exported row.

    For exportSource OBSERVATIONS_V2 or LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS: must include core if provided. When omitted on create, the column default (all groups) applies. When omitted on update, the existing value is preserved.

    For exportSource LEGACY_TRACES_OBSERVATIONS: this field must be omitted or null. Sending an array (including an empty array) returns 400, because that source uses a fixed column set and does not honor field groups.

    exportFieldGroups requires exportSource to be provided in the same request.

    exportFrequency: BlobStorageExportFrequency
    exportMode: BlobStorageExportMode
    exportSource?: BlobStorageExportSource

    Data to export. When omitted on update, the existing value is preserved. When omitted on create: pre-cutoff Cloud projects and self-hosted deployments fall back to LEGACY_TRACES_OBSERVATIONS; post-cutoff Cloud projects (created on or after 2026-05-20) auto-default to OBSERVATIONS_V2. Required when exportFieldGroups is provided.

    Cloud-only deprecation gate (effective 2026-05-20): For projects created on or after 2026-05-20 on Langfuse Cloud, LEGACY_TRACES_OBSERVATIONS and LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS are rejected with HTTP 400. Omitting exportSource on these projects silently defaults to OBSERVATIONS_V2 rather than the schema column default. Use OBSERVATIONS_V2 for all new integrations. Projects created before 2026-05-20 and self-hosted deployments are unaffected.

    exportStartDate?: string

    Custom start date for exports (required when exportMode is FROM_CUSTOM_DATE)

    fileType: BlobStorageIntegrationFileType
    forcePathStyle: boolean

    Use path-style URLs for S3 requests

    prefix?: string

    Path prefix for exported files (must end with forward slash if provided)

    projectId: string

    ID of the project in which to configure the blob storage integration

    region: string

    Storage region

    secretAccessKey?: string

    Secret access key for authentication (will be encrypted when stored)

    type: BlobStorageIntegrationType

    Settings

    Member Visibility

    On This Page

    Properties