Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getBundle
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.getBundle

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A Bundle is the API/SDK term for the feature called Share Links in the web interface.

    The API provides the full set of actions related to Share Links, including sending them via E-Mail.

    Please note that we very closely monitor the E-Mailing feature and any abuse will result in disabling of your site.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleBundle = filescom.getBundle({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_bundle = filescom.get_bundle(id=1)

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.GetBundle(ctx, &filescom.LookupBundleArgs{
			Id: 1,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleBundle = Filescom.GetBundle.Invoke(new()
    {
        Id = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetBundleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleBundle = FilescomFunctions.getBundle(GetBundleArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleBundle:
    fn::invoke:
      function: filescom:getBundle
      arguments:
        id: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

data "filescom_getbundle" "exampleBundle" {
  id = 1
}

    Using getBundle

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBundle(args: GetBundleArgs, opts?: InvokeOptions): Promise<GetBundleResult>
function getBundleOutput(args: GetBundleOutputArgs, opts?: InvokeOutputOptions): Output<GetBundleResult>
    def get_bundle(id: Optional[int] = None,
               opts: Optional[InvokeOptions] = None) -> GetBundleResult
def get_bundle_output(id: pulumi.Input[Optional[int]] = None,
               opts: Optional[InvokeOutputOptions] = None) -> Output[GetBundleResult]
    func LookupBundle(ctx *Context, args *LookupBundleArgs, opts ...InvokeOption) (*LookupBundleResult, error)
func LookupBundleOutput(ctx *Context, args *LookupBundleOutputArgs, opts ...InvokeOption) LookupBundleResultOutput

    > Note: This function is named LookupBundle in the Go SDK.

    public static class GetBundle 
{
    public static Task<GetBundleResult> InvokeAsync(GetBundleArgs args, InvokeOptions? opts = null)
    public static Output<GetBundleResult> Invoke(GetBundleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBundleResult> Invoke(GetBundleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBundleResult> getBundle(GetBundleArgs args, InvokeOptions options)
public static Output<GetBundleResult> getBundle(GetBundleArgs args, InvokeOptions options)
public static Output<GetBundleResult> getBundle(GetBundleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getBundle:getBundle
  arguments:
    # arguments dictionary
    data "filescom_get_bundle" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    Bundle ID
    Id int
    Bundle ID
    id number
    Bundle ID
    id Integer
    Bundle ID
    id number
    Bundle ID
    id int
    Bundle ID
    id Number
    Bundle ID

    getBundle Result

    The following output properties are available:

    Bundlepaths object
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    BypassesSiteExpirationRules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    ClickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    ClickwrapId int
    ID of the clickwrap to use with this bundle.
    Code string
    Bundle code. This code forms the end part of the Public URL.
    ColorLeft string
    Page link and button color
    ColorLink string
    Top bar link color
    ColorText string
    Page link and button color
    ColorTop string
    Top bar background color
    ColorTopText string
    Top bar text color
    CreatedAt string
    Bundle created at date/time
    Deleted bool
    Indicates if the bundle has been deleted.
    DeletedAt string
    Bundle deleted at date/time
    Description string
    Public description
    DontAllowFoldersInUploads bool
    Should folder uploads be prevented?
    DontSeparateSubmissionsByFolder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    ExpiresAt string
    Bundle expiration date/time
    FormFieldSet string
    Custom Form to use
    GroupId int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    HasInbox bool
    Does this bundle have an associated inbox?
    Id int
    Bundle ID
    InboxId int
    ID of the associated inbox, if available.
    InternalName string
    Internal name for identifying this Share Link.
    MaxUses int
    Maximum number of times bundle can be accessed
    Note string
    Bundle internal note
    PasswordProtected bool
    Is this bundle password protected?
    PathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    PathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    Paths List<string>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    Permissions string
    Permissions that apply to Folders in this Share Link.
    PreviewOnly bool
    RequestedUploadSlots object
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    RequireLogout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    RequireRegistration bool
    Show a registration page that captures the downloader's name and email address?
    RequireShareRecipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    SendEmailReceiptToUploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    SendOneTimePasswordToRecipientAtRegistration bool
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    SkipCompany bool
    BundleRegistrations can be saved without providing company?
    SkipEmail bool
    BundleRegistrations can be saved without providing email?
    SkipName bool
    BundleRegistrations can be saved without providing name?
    SnapshotId int
    ID of the snapshot containing this bundle's contents.
    StartAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    Url string
    Public URL of Share Link
    UserId int
    Bundle creator user ID
    Username string
    Bundle creator username
    WatermarkAttachment string
    Preview watermark image applied to all bundle items.
    WatermarkValue object
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    Bundlepaths interface{}
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    BypassesSiteExpirationRules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    ClickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    ClickwrapId int
    ID of the clickwrap to use with this bundle.
    Code string
    Bundle code. This code forms the end part of the Public URL.
    ColorLeft string
    Page link and button color
    ColorLink string
    Top bar link color
    ColorText string
    Page link and button color
    ColorTop string
    Top bar background color
    ColorTopText string
    Top bar text color
    CreatedAt string
    Bundle created at date/time
    Deleted bool
    Indicates if the bundle has been deleted.
    DeletedAt string
    Bundle deleted at date/time
    Description string
    Public description
    DontAllowFoldersInUploads bool
    Should folder uploads be prevented?
    DontSeparateSubmissionsByFolder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    ExpiresAt string
    Bundle expiration date/time
    FormFieldSet string
    Custom Form to use
    GroupId int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    HasInbox bool
    Does this bundle have an associated inbox?
    Id int
    Bundle ID
    InboxId int
    ID of the associated inbox, if available.
    InternalName string
    Internal name for identifying this Share Link.
    MaxUses int
    Maximum number of times bundle can be accessed
    Note string
    Bundle internal note
    PasswordProtected bool
    Is this bundle password protected?
    PathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    PathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    Paths []string
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    Permissions string
    Permissions that apply to Folders in this Share Link.
    PreviewOnly bool
    RequestedUploadSlots interface{}
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    RequireLogout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    RequireRegistration bool
    Show a registration page that captures the downloader's name and email address?
    RequireShareRecipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    SendEmailReceiptToUploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    SendOneTimePasswordToRecipientAtRegistration bool
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    SkipCompany bool
    BundleRegistrations can be saved without providing company?
    SkipEmail bool
    BundleRegistrations can be saved without providing email?
    SkipName bool
    BundleRegistrations can be saved without providing name?
    SnapshotId int
    ID of the snapshot containing this bundle's contents.
    StartAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    Url string
    Public URL of Share Link
    UserId int
    Bundle creator user ID
    Username string
    Bundle creator username
    WatermarkAttachment string
    Preview watermark image applied to all bundle items.
    WatermarkValue interface{}
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    bundlepaths any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypasses_site_expiration_rules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrap_body string
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrap_id number
    ID of the clickwrap to use with this bundle.
    code string
    Bundle code. This code forms the end part of the Public URL.
    color_left string
    Page link and button color
    color_link string
    Top bar link color
    color_text string
    Page link and button color
    color_top string
    Top bar background color
    color_top_text string
    Top bar text color
    created_at string
    Bundle created at date/time
    deleted bool
    Indicates if the bundle has been deleted.
    deleted_at string
    Bundle deleted at date/time
    description string
    Public description
    dont_allow_folders_in_uploads bool
    Should folder uploads be prevented?
    dont_separate_submissions_by_folder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expires_at string
    Bundle expiration date/time
    form_field_set string
    Custom Form to use
    group_id number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    has_inbox bool
    Does this bundle have an associated inbox?
    id number
    Bundle ID
    inbox_id number
    ID of the associated inbox, if available.
    internal_name string
    Internal name for identifying this Share Link.
    max_uses number
    Maximum number of times bundle can be accessed
    note string
    Bundle internal note
    password_protected bool
    Is this bundle password protected?
    path_template string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    path_template_time_zone string
    Timezone to use when rendering timestamps in path templates.
    paths list(string)
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions string
    Permissions that apply to Folders in this Share Link.
    preview_only bool
    requested_upload_slots any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    require_logout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    require_registration bool
    Show a registration page that captures the downloader's name and email address?
    require_share_recipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    send_email_receipt_to_uploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    send_one_time_password_to_recipient_at_registration bool
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skip_company bool
    BundleRegistrations can be saved without providing company?
    skip_email bool
    BundleRegistrations can be saved without providing email?
    skip_name bool
    BundleRegistrations can be saved without providing name?
    snapshot_id number
    ID of the snapshot containing this bundle's contents.
    start_access_on_date string
    Date when share will start to be accessible. If nil access granted right after create.
    url string
    Public URL of Share Link
    user_id number
    Bundle creator user ID
    username string
    Bundle creator username
    watermark_attachment string
    Preview watermark image applied to all bundle items.
    watermark_value any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspace_id number
    Workspace ID. 0 means the default workspace.
    bundlepaths Object
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules Boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapBody String
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrapId Integer
    ID of the clickwrap to use with this bundle.
    code String
    Bundle code. This code forms the end part of the Public URL.
    colorLeft String
    Page link and button color
    colorLink String
    Top bar link color
    colorText String
    Page link and button color
    colorTop String
    Top bar background color
    colorTopText String
    Top bar text color
    createdAt String
    Bundle created at date/time
    deleted Boolean
    Indicates if the bundle has been deleted.
    deletedAt String
    Bundle deleted at date/time
    description String
    Public description
    dontAllowFoldersInUploads Boolean
    Should folder uploads be prevented?
    dontSeparateSubmissionsByFolder Boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt String
    Bundle expiration date/time
    formFieldSet String
    Custom Form to use
    groupId Integer
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    hasInbox Boolean
    Does this bundle have an associated inbox?
    id Integer
    Bundle ID
    inboxId Integer
    ID of the associated inbox, if available.
    internalName String
    Internal name for identifying this Share Link.
    maxUses Integer
    Maximum number of times bundle can be accessed
    note String
    Bundle internal note
    passwordProtected Boolean
    Is this bundle password protected?
    pathTemplate String
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone String
    Timezone to use when rendering timestamps in path templates.
    paths List<String>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions String
    Permissions that apply to Folders in this Share Link.
    previewOnly Boolean
    requestedUploadSlots Object
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout Boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    requireRegistration Boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient Boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader Boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration Boolean
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany Boolean
    BundleRegistrations can be saved without providing company?
    skipEmail Boolean
    BundleRegistrations can be saved without providing email?
    skipName Boolean
    BundleRegistrations can be saved without providing name?
    snapshotId Integer
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate String
    Date when share will start to be accessible. If nil access granted right after create.
    url String
    Public URL of Share Link
    userId Integer
    Bundle creator user ID
    username String
    Bundle creator username
    watermarkAttachment String
    Preview watermark image applied to all bundle items.
    watermarkValue Object
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    bundlepaths any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrapId number
    ID of the clickwrap to use with this bundle.
    code string
    Bundle code. This code forms the end part of the Public URL.
    colorLeft string
    Page link and button color
    colorLink string
    Top bar link color
    colorText string
    Page link and button color
    colorTop string
    Top bar background color
    colorTopText string
    Top bar text color
    createdAt string
    Bundle created at date/time
    deleted boolean
    Indicates if the bundle has been deleted.
    deletedAt string
    Bundle deleted at date/time
    description string
    Public description
    dontAllowFoldersInUploads boolean
    Should folder uploads be prevented?
    dontSeparateSubmissionsByFolder boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt string
    Bundle expiration date/time
    formFieldSet string
    Custom Form to use
    groupId number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    hasInbox boolean
    Does this bundle have an associated inbox?
    id number
    Bundle ID
    inboxId number
    ID of the associated inbox, if available.
    internalName string
    Internal name for identifying this Share Link.
    maxUses number
    Maximum number of times bundle can be accessed
    note string
    Bundle internal note
    passwordProtected boolean
    Is this bundle password protected?
    pathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    paths string[]
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions string
    Permissions that apply to Folders in this Share Link.
    previewOnly boolean
    requestedUploadSlots any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    requireRegistration boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration boolean
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany boolean
    BundleRegistrations can be saved without providing company?
    skipEmail boolean
    BundleRegistrations can be saved without providing email?
    skipName boolean
    BundleRegistrations can be saved without providing name?
    snapshotId number
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    url string
    Public URL of Share Link
    userId number
    Bundle creator user ID
    username string
    Bundle creator username
    watermarkAttachment string
    Preview watermark image applied to all bundle items.
    watermarkValue any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspaceId number
    Workspace ID. 0 means the default workspace.
    bundlepaths Any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypasses_site_expiration_rules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrap_body str
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrap_id int
    ID of the clickwrap to use with this bundle.
    code str
    Bundle code. This code forms the end part of the Public URL.
    color_left str
    Page link and button color
    color_link str
    Top bar link color
    color_text str
    Page link and button color
    color_top str
    Top bar background color
    color_top_text str
    Top bar text color
    created_at str
    Bundle created at date/time
    deleted bool
    Indicates if the bundle has been deleted.
    deleted_at str
    Bundle deleted at date/time
    description str
    Public description
    dont_allow_folders_in_uploads bool
    Should folder uploads be prevented?
    dont_separate_submissions_by_folder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expires_at str
    Bundle expiration date/time
    form_field_set str
    Custom Form to use
    group_id int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    has_inbox bool
    Does this bundle have an associated inbox?
    id int
    Bundle ID
    inbox_id int
    ID of the associated inbox, if available.
    internal_name str
    Internal name for identifying this Share Link.
    max_uses int
    Maximum number of times bundle can be accessed
    note str
    Bundle internal note
    password_protected bool
    Is this bundle password protected?
    path_template str
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    path_template_time_zone str
    Timezone to use when rendering timestamps in path templates.
    paths Sequence[str]
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions str
    Permissions that apply to Folders in this Share Link.
    preview_only bool
    requested_upload_slots Any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    require_logout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    require_registration bool
    Show a registration page that captures the downloader's name and email address?
    require_share_recipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    send_email_receipt_to_uploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    send_one_time_password_to_recipient_at_registration bool
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skip_company bool
    BundleRegistrations can be saved without providing company?
    skip_email bool
    BundleRegistrations can be saved without providing email?
    skip_name bool
    BundleRegistrations can be saved without providing name?
    snapshot_id int
    ID of the snapshot containing this bundle's contents.
    start_access_on_date str
    Date when share will start to be accessible. If nil access granted right after create.
    url str
    Public URL of Share Link
    user_id int
    Bundle creator user ID
    username str
    Bundle creator username
    watermark_attachment str
    Preview watermark image applied to all bundle items.
    watermark_value Any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspace_id int
    Workspace ID. 0 means the default workspace.
    bundlepaths Any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules Boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapBody String
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrapId Number
    ID of the clickwrap to use with this bundle.
    code String
    Bundle code. This code forms the end part of the Public URL.
    colorLeft String
    Page link and button color
    colorLink String
    Top bar link color
    colorText String
    Page link and button color
    colorTop String
    Top bar background color
    colorTopText String
    Top bar text color
    createdAt String
    Bundle created at date/time
    deleted Boolean
    Indicates if the bundle has been deleted.
    deletedAt String
    Bundle deleted at date/time
    description String
    Public description
    dontAllowFoldersInUploads Boolean
    Should folder uploads be prevented?
    dontSeparateSubmissionsByFolder Boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt String
    Bundle expiration date/time
    formFieldSet String
    Custom Form to use
    groupId Number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    hasInbox Boolean
    Does this bundle have an associated inbox?
    id Number
    Bundle ID
    inboxId Number
    ID of the associated inbox, if available.
    internalName String
    Internal name for identifying this Share Link.
    maxUses Number
    Maximum number of times bundle can be accessed
    note String
    Bundle internal note
    passwordProtected Boolean
    Is this bundle password protected?
    pathTemplate String
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone String
    Timezone to use when rendering timestamps in path templates.
    paths List<String>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions String
    Permissions that apply to Folders in this Share Link.
    previewOnly Boolean
    requestedUploadSlots Any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout Boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    requireRegistration Boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient Boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader Boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration Boolean
    If true, requiresharerecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany Boolean
    BundleRegistrations can be saved without providing company?
    skipEmail Boolean
    BundleRegistrations can be saved without providing email?
    skipName Boolean
    BundleRegistrations can be saved without providing name?
    snapshotId Number
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate String
    Date when share will start to be accessible. If nil access granted right after create.
    url String
    Public URL of Share Link
    userId Number
    Bundle creator user ID
    username String
    Bundle creator username
    watermarkAttachment String
    Preview watermark image applied to all bundle items.
    watermarkValue Any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial