Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getBehavior
Viewing docs for Files.com v0.2.0
published on Wednesday, Sep 30, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.getBehavior

filescom logo Files.com
Viewing docs for Files.com v0.2.0
published on Wednesday, Sep 30, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A Behavior is an API resource for what are also known as Folder Settings. Every behavior is associated with a folder.

    Depending on the behavior, it may also operate on child folders. It may be overridable at the child folder level or maybe can be added to at the child folder level.

    Each behavior type also has a recursion mode in the behavior type documentation. always means the behavior is always recursive, never means it is never recursive, and sometimes means callers may choose the value of the recursive field.

    Additionally, some behaviors are visible to non-admins, and others are even settable by non-admins.

    Each behavior uses a different format for its settings value. The Behavior resource examples show the value for each behavior type. In the REST API, send these settings as JSON within the value field.

    Note: Append Timestamp behavior removed. Check Override Upload Filename behavior which have even more functionality to modify name on upload.

    Example Usage

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

const exampleBehavior = filescom.getBehavior({
    id: 1,
    valueFormat: "typed",
});

    import pulumi
import pulumi_filescom as filescom

example_behavior = filescom.get_behavior(id=1,
    value_format="typed")

    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.GetBehavior(ctx, &filescom.LookupBehaviorArgs{
			Id:          1,
			ValueFormat: pulumi.StringRef("typed"),
		}, 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 exampleBehavior = Filescom.GetBehavior.Invoke(new()
    {
        Id = 1,
        ValueFormat = "typed",
    });

});

    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.GetBehaviorArgs;
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 exampleBehavior = FilescomFunctions.getBehavior(GetBehaviorArgs.builder()
            .id(1)
            .valueFormat("typed")
            .build());

    }
}

    variables:
  exampleBehavior:
    fn::invoke:
      function: filescom:getBehavior
      arguments:
        id: 1
        valueFormat: typed

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

data "filescom_getbehavior" "exampleBehavior" {
  id           = 1
  value_format = "typed"
}

    Using getBehavior

    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 getBehavior(args: GetBehaviorArgs, opts?: InvokeOptions): Promise<GetBehaviorResult>
function getBehaviorOutput(args: GetBehaviorOutputArgs, opts?: InvokeOutputOptions): Output<GetBehaviorResult>
    def get_behavior(id: Optional[int] = None,
                 value_format: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetBehaviorResult
def get_behavior_output(id: pulumi.Input[Optional[int]] = None,
                 value_format: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetBehaviorResult]
    func LookupBehavior(ctx *Context, args *LookupBehaviorArgs, opts ...InvokeOption) (*LookupBehaviorResult, error)
func LookupBehaviorOutput(ctx *Context, args *LookupBehaviorOutputArgs, opts ...InvokeOption) LookupBehaviorResultOutput

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

    public static class GetBehavior 
{
    public static Task<GetBehaviorResult> InvokeAsync(GetBehaviorArgs args, InvokeOptions? opts = null)
    public static Output<GetBehaviorResult> Invoke(GetBehaviorInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBehaviorResult> Invoke(GetBehaviorInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBehaviorResult> getBehavior(GetBehaviorArgs args, InvokeOptions options)
public static Output<GetBehaviorResult> getBehavior(GetBehaviorArgs args, InvokeOptions options)
public static Output<GetBehaviorResult> getBehavior(GetBehaviorArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getBehavior:getBehavior
  arguments:
    # arguments dictionary
    data "filescom_get_behavior" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    Folder behavior ID
    ValueFormat string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    Id int
    Folder behavior ID
    ValueFormat string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    id number
    Folder behavior ID
    value_format string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    id Integer
    Folder behavior ID
    valueFormat String
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    id number
    Folder behavior ID
    valueFormat string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    id int
    Folder behavior ID
    value_format str
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    id Number
    Folder behavior ID
    valueFormat String
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.

    getBehavior Result

    The following output properties are available:

    AttachmentUrl string
    URL for attached file
    Behavior string
    Behavior type.
    Description string
    Description for this behavior.
    DisableParentFolderBehavior bool
    If true, the parent folder's behavior will be disabled for this folder and its children.
    Id int
    Folder behavior ID
    Inherited bool
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    Managed bool
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    Name string
    Name for this behavior.
    Path string
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    PublicHostingUrl string
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    Recursive bool
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    RootBehaviorSiteAdminOnly bool
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    Value object
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    ValueFormat string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    AttachmentUrl string
    URL for attached file
    Behavior string
    Behavior type.
    Description string
    Description for this behavior.
    DisableParentFolderBehavior bool
    If true, the parent folder's behavior will be disabled for this folder and its children.
    Id int
    Folder behavior ID
    Inherited bool
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    Managed bool
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    Name string
    Name for this behavior.
    Path string
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    PublicHostingUrl string
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    Recursive bool
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    RootBehaviorSiteAdminOnly bool
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    Value interface{}
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    ValueFormat string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    attachment_url string
    URL for attached file
    behavior string
    Behavior type.
    description string
    Description for this behavior.
    disable_parent_folder_behavior bool
    If true, the parent folder's behavior will be disabled for this folder and its children.
    id number
    Folder behavior ID
    inherited bool
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    managed bool
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    name string
    Name for this behavior.
    path string
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    public_hosting_url string
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    recursive bool
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    root_behavior_site_admin_only bool
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    value any
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    value_format string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    attachmentUrl String
    URL for attached file
    behavior String
    Behavior type.
    description String
    Description for this behavior.
    disableParentFolderBehavior Boolean
    If true, the parent folder's behavior will be disabled for this folder and its children.
    id Integer
    Folder behavior ID
    inherited Boolean
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    managed Boolean
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    name String
    Name for this behavior.
    path String
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    publicHostingUrl String
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    recursive Boolean
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    rootBehaviorSiteAdminOnly Boolean
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    value Object
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    valueFormat String
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    attachmentUrl string
    URL for attached file
    behavior string
    Behavior type.
    description string
    Description for this behavior.
    disableParentFolderBehavior boolean
    If true, the parent folder's behavior will be disabled for this folder and its children.
    id number
    Folder behavior ID
    inherited boolean
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    managed boolean
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    name string
    Name for this behavior.
    path string
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    publicHostingUrl string
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    recursive boolean
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    rootBehaviorSiteAdminOnly boolean
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    value any
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    valueFormat string
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    attachment_url str
    URL for attached file
    behavior str
    Behavior type.
    description str
    Description for this behavior.
    disable_parent_folder_behavior bool
    If true, the parent folder's behavior will be disabled for this folder and its children.
    id int
    Folder behavior ID
    inherited bool
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    managed bool
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    name str
    Name for this behavior.
    path str
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    public_hosting_url str
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    recursive bool
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    root_behavior_site_admin_only bool
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    value Any
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    value_format str
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.
    attachmentUrl String
    URL for attached file
    behavior String
    Behavior type.
    description String
    Description for this behavior.
    disableParentFolderBehavior Boolean
    If true, the parent folder's behavior will be disabled for this folder and its children.
    id Number
    Folder behavior ID
    inherited Boolean
    If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.
    managed Boolean
    If true, this behavior is controlled by a parent-site policy and cannot be modified locally.
    name String
    Name for this behavior.
    path String
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    publicHostingUrl String
    Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with publicHosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host.
    recursive Boolean
    Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.
    rootBehaviorSiteAdminOnly Boolean
    If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.
    value Any
    Settings for this behavior. Set valueFormat to "typed" to return it wrapped under the behavior name.
    valueFormat String
    Set to "typed" to return value wrapped under the behavior name. Files.com plans to make this the default on March 1, 2027.

    Package Details

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial