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

filescom.ApiKey

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

    An APIKey is a key that allows programmatic access to your Site.

    API keys confer all the permissions of the user who owns them unless the key uses a restricted permission set.

    If an API key is created without a user owner, it is considered a site-wide API key. Site-wide API keys with the filesOnly permission set are restricted to file-user permissions and workspace scoping.

    We recommend registering API keys to service users wherever possible and then using User or Group Permissions to restrict that API Key appropriately.

    Example Usage

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

const exampleApiKey = new filescom.ApiKey("example_api_key", {
    userId: 1,
    description: "example",
    expiresAt: "2000-01-01T01:00:00Z",
    name: "My Main API Key",
    awsStyleCredentials: true,
    path: "shared/docs",
    permissionSet: "full",
    workspaceId: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_api_key = filescom.ApiKey("example_api_key",
    user_id=1,
    description="example",
    expires_at="2000-01-01T01:00:00Z",
    name="My Main API Key",
    aws_style_credentials=True,
    path="shared/docs",
    permission_set="full",
    workspace_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.NewApiKey(ctx, "example_api_key", &filescom.ApiKeyArgs{
			UserId:              pulumi.Int(1),
			Description:         pulumi.String("example"),
			ExpiresAt:           pulumi.String("2000-01-01T01:00:00Z"),
			Name:                pulumi.String("My Main API Key"),
			AwsStyleCredentials: pulumi.Bool(true),
			Path:                pulumi.String("shared/docs"),
			PermissionSet:       pulumi.String("full"),
			WorkspaceId:         pulumi.Int(1),
		})
		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 exampleApiKey = new Filescom.ApiKey("example_api_key", new()
    {
        UserId = 1,
        Description = "example",
        ExpiresAt = "2000-01-01T01:00:00Z",
        Name = "My Main API Key",
        AwsStyleCredentials = true,
        Path = "shared/docs",
        PermissionSet = "full",
        WorkspaceId = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.ApiKey;
import com.pulumi.filescom.ApiKeyArgs;
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) {
        var exampleApiKey = new ApiKey("exampleApiKey", ApiKeyArgs.builder()
            .userId(1)
            .description("example")
            .expiresAt("2000-01-01T01:00:00Z")
            .name("My Main API Key")
            .awsStyleCredentials(true)
            .path("shared/docs")
            .permissionSet("full")
            .workspaceId(1)
            .build());

    }
}

    resources:
  exampleApiKey:
    type: filescom:ApiKey
    name: example_api_key
    properties:
      userId: 1
      description: example
      expiresAt: 2000-01-01T01:00:00Z
      name: My Main API Key
      awsStyleCredentials: true
      path: shared/docs
      permissionSet: full
      workspaceId: 1

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

resource "filescom_apikey" "example_api_key" {
  user_id               = 1
  description           = "example"
  expires_at            = "2000-01-01T01:00:00Z"
  name                  = "My Main API Key"
  aws_style_credentials = true
  path                  = "shared/docs"
  permission_set        = "full"
  workspace_id          = 1
}

    Create ApiKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiKey(name: string, args?: ApiKeyArgs, opts?: CustomResourceOptions);
    @overload
def ApiKey(resource_name: str,
           args: Optional[ApiKeyArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           aws_style_credentials: Optional[bool] = None,
           description: Optional[str] = None,
           expires_at: Optional[str] = None,
           name: Optional[str] = None,
           path: Optional[str] = None,
           permission_set: Optional[str] = None,
           user_id: Optional[int] = None,
           workspace_id: Optional[int] = None)
    func NewApiKey(ctx *Context, name string, args *ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
    public ApiKey(string name, ApiKeyArgs? args = null, CustomResourceOptions? opts = null)
    public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

    type: filescom:ApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_api_key" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiKeyResource = new Filescom.ApiKey("apiKeyResource", new()
{
    AwsStyleCredentials = false,
    Description = "string",
    ExpiresAt = "string",
    Name = "string",
    Path = "string",
    PermissionSet = "string",
    UserId = 0,
    WorkspaceId = 0,
});

    example, err := filescom.NewApiKey(ctx, "apiKeyResource", &filescom.ApiKeyArgs{
	AwsStyleCredentials: pulumi.Bool(false),
	Description:         pulumi.String("string"),
	ExpiresAt:           pulumi.String("string"),
	Name:                pulumi.String("string"),
	Path:                pulumi.String("string"),
	PermissionSet:       pulumi.String("string"),
	UserId:              pulumi.Int(0),
	WorkspaceId:         pulumi.Int(0),
})

    resource "filescom_api_key" "apiKeyResource" {
  lifecycle {
    create_before_destroy = true
  }
  aws_style_credentials = false
  description           = "string"
  expires_at            = "string"
  name                  = "string"
  path                  = "string"
  permission_set        = "string"
  user_id               = 0
  workspace_id          = 0
}

    var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .awsStyleCredentials(false)
    .description("string")
    .expiresAt("string")
    .name("string")
    .path("string")
    .permissionSet("string")
    .userId(0)
    .workspaceId(0)
    .build());

    api_key_resource = filescom.ApiKey("apiKeyResource",
    aws_style_credentials=False,
    description="string",
    expires_at="string",
    name="string",
    path="string",
    permission_set="string",
    user_id=0,
    workspace_id=0)

    const apiKeyResource = new filescom.ApiKey("apiKeyResource", {
    awsStyleCredentials: false,
    description: "string",
    expiresAt: "string",
    name: "string",
    path: "string",
    permissionSet: "string",
    userId: 0,
    workspaceId: 0,
});

    type: filescom:ApiKey
properties:
    awsStyleCredentials: false
    description: string
    expiresAt: string
    name: string
    path: string
    permissionSet: string
    userId: 0
    workspaceId: 0

    ApiKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiKey resource accepts the following input properties:

    AwsStyleCredentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    Description string
    User-supplied description of API key.
    ExpiresAt string
    API Key expiration date
    Name string
    Internal name for the API Key. For your use.
    Path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    PermissionSet string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    UserId int
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    WorkspaceId int
    Workspace ID for this API Key. 0 means the default workspace.
    AwsStyleCredentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    Description string
    User-supplied description of API key.
    ExpiresAt string
    API Key expiration date
    Name string
    Internal name for the API Key. For your use.
    Path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    PermissionSet string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    UserId int
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    WorkspaceId int
    Workspace ID for this API Key. 0 means the default workspace.
    aws_style_credentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    description string
    User-supplied description of API key.
    expires_at string
    API Key expiration date
    name string
    Internal name for the API Key. For your use.
    path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permission_set string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    user_id number
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspace_id number
    Workspace ID for this API Key. 0 means the default workspace.
    awsStyleCredentials Boolean
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    description String
    User-supplied description of API key.
    expiresAt String
    API Key expiration date
    name String
    Internal name for the API Key. For your use.
    path String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permissionSet String
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    userId Integer
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspaceId Integer
    Workspace ID for this API Key. 0 means the default workspace.
    awsStyleCredentials boolean
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    description string
    User-supplied description of API key.
    expiresAt string
    API Key expiration date
    name string
    Internal name for the API Key. For your use.
    path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permissionSet string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    userId number
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspaceId number
    Workspace ID for this API Key. 0 means the default workspace.
    aws_style_credentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    description str
    User-supplied description of API key.
    expires_at str
    API Key expiration date
    name str
    Internal name for the API Key. For your use.
    path str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permission_set str
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    user_id int
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspace_id int
    Workspace ID for this API Key. 0 means the default workspace.
    awsStyleCredentials Boolean
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    description String
    User-supplied description of API key.
    expiresAt String
    API Key expiration date
    name String
    Internal name for the API Key. For your use.
    path String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permissionSet String
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    userId Number
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspaceId Number
    Workspace ID for this API Key. 0 means the default workspace.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiKey resource produces the following output properties:

    AwsAccessKeyId string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    AwsSecretKey string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    CreatedAt string
    Time which API Key was created
    DescriptiveLabel string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    API Key actual key string
    LastUseAt string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    Platform string
    If this API key represents a Desktop app, what platform was it created on?
    SiteId int
    Site ID
    SiteName string
    Site Name
    Url string
    URL for API host.
    AwsAccessKeyId string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    AwsSecretKey string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    CreatedAt string
    Time which API Key was created
    DescriptiveLabel string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    API Key actual key string
    LastUseAt string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    Platform string
    If this API key represents a Desktop app, what platform was it created on?
    SiteId int
    Site ID
    SiteName string
    Site Name
    Url string
    URL for API host.
    aws_access_key_id string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    aws_secret_key string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    created_at string
    Time which API Key was created
    descriptive_label string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    API Key actual key string
    last_use_at string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    platform string
    If this API key represents a Desktop app, what platform was it created on?
    site_id number
    Site ID
    site_name string
    Site Name
    url string
    URL for API host.
    awsAccessKeyId String
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsSecretKey String
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    createdAt String
    Time which API Key was created
    descriptiveLabel String
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    API Key actual key string
    lastUseAt String
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    platform String
    If this API key represents a Desktop app, what platform was it created on?
    siteId Integer
    Site ID
    siteName String
    Site Name
    url String
    URL for API host.
    awsAccessKeyId string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsSecretKey string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    createdAt string
    Time which API Key was created
    descriptiveLabel string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    API Key actual key string
    lastUseAt string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    platform string
    If this API key represents a Desktop app, what platform was it created on?
    siteId number
    Site ID
    siteName string
    Site Name
    url string
    URL for API host.
    aws_access_key_id str
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    aws_secret_key str
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    created_at str
    Time which API Key was created
    descriptive_label str
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    API Key actual key string
    last_use_at str
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    platform str
    If this API key represents a Desktop app, what platform was it created on?
    site_id int
    Site ID
    site_name str
    Site Name
    url str
    URL for API host.
    awsAccessKeyId String
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsSecretKey String
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    createdAt String
    Time which API Key was created
    descriptiveLabel String
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    API Key actual key string
    lastUseAt String
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    platform String
    If this API key represents a Desktop app, what platform was it created on?
    siteId Number
    Site ID
    siteName String
    Site Name
    url String
    URL for API host.

    Look up Existing ApiKey Resource

    Get an existing ApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiKeyState, opts?: CustomResourceOptions): ApiKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_access_key_id: Optional[str] = None,
        aws_secret_key: Optional[str] = None,
        aws_style_credentials: Optional[bool] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        descriptive_label: Optional[str] = None,
        expires_at: Optional[str] = None,
        key: Optional[str] = None,
        last_use_at: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        permission_set: Optional[str] = None,
        platform: Optional[str] = None,
        site_id: Optional[int] = None,
        site_name: Optional[str] = None,
        url: Optional[str] = None,
        user_id: Optional[int] = None,
        workspace_id: Optional[int] = None) -> ApiKey
    func GetApiKey(ctx *Context, name string, id IDInput, state *ApiKeyState, opts ...ResourceOption) (*ApiKey, error)
    public static ApiKey Get(string name, Input<string> id, ApiKeyState? state, CustomResourceOptions? opts = null)
    public static ApiKey get(String name, Output<String> id, ApiKeyState state, CustomResourceOptions options)
    resources:  _:    type: filescom:ApiKey    get:      id: ${id}
    import {
  to = filescom_api_key.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AwsAccessKeyId string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    AwsSecretKey string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    AwsStyleCredentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    CreatedAt string
    Time which API Key was created
    Description string
    User-supplied description of API key.
    DescriptiveLabel string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    ExpiresAt string
    API Key expiration date
    Key string
    API Key actual key string
    LastUseAt string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    Name string
    Internal name for the API Key. For your use.
    Path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    PermissionSet string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    Platform string
    If this API key represents a Desktop app, what platform was it created on?
    SiteId int
    Site ID
    SiteName string
    Site Name
    Url string
    URL for API host.
    UserId int
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    WorkspaceId int
    Workspace ID for this API Key. 0 means the default workspace.
    AwsAccessKeyId string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    AwsSecretKey string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    AwsStyleCredentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    CreatedAt string
    Time which API Key was created
    Description string
    User-supplied description of API key.
    DescriptiveLabel string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    ExpiresAt string
    API Key expiration date
    Key string
    API Key actual key string
    LastUseAt string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    Name string
    Internal name for the API Key. For your use.
    Path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    PermissionSet string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    Platform string
    If this API key represents a Desktop app, what platform was it created on?
    SiteId int
    Site ID
    SiteName string
    Site Name
    Url string
    URL for API host.
    UserId int
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    WorkspaceId int
    Workspace ID for this API Key. 0 means the default workspace.
    aws_access_key_id string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    aws_secret_key string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    aws_style_credentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    created_at string
    Time which API Key was created
    description string
    User-supplied description of API key.
    descriptive_label string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    expires_at string
    API Key expiration date
    key string
    API Key actual key string
    last_use_at string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    name string
    Internal name for the API Key. For your use.
    path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permission_set string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    platform string
    If this API key represents a Desktop app, what platform was it created on?
    site_id number
    Site ID
    site_name string
    Site Name
    url string
    URL for API host.
    user_id number
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspace_id number
    Workspace ID for this API Key. 0 means the default workspace.
    awsAccessKeyId String
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsSecretKey String
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsStyleCredentials Boolean
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    createdAt String
    Time which API Key was created
    description String
    User-supplied description of API key.
    descriptiveLabel String
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    expiresAt String
    API Key expiration date
    key String
    API Key actual key string
    lastUseAt String
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    name String
    Internal name for the API Key. For your use.
    path String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permissionSet String
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    platform String
    If this API key represents a Desktop app, what platform was it created on?
    siteId Integer
    Site ID
    siteName String
    Site Name
    url String
    URL for API host.
    userId Integer
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspaceId Integer
    Workspace ID for this API Key. 0 means the default workspace.
    awsAccessKeyId string
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsSecretKey string
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsStyleCredentials boolean
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    createdAt string
    Time which API Key was created
    description string
    User-supplied description of API key.
    descriptiveLabel string
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    expiresAt string
    API Key expiration date
    key string
    API Key actual key string
    lastUseAt string
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    name string
    Internal name for the API Key. For your use.
    path string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permissionSet string
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    platform string
    If this API key represents a Desktop app, what platform was it created on?
    siteId number
    Site ID
    siteName string
    Site Name
    url string
    URL for API host.
    userId number
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspaceId number
    Workspace ID for this API Key. 0 means the default workspace.
    aws_access_key_id str
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    aws_secret_key str
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    aws_style_credentials bool
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    created_at str
    Time which API Key was created
    description str
    User-supplied description of API key.
    descriptive_label str
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    expires_at str
    API Key expiration date
    key str
    API Key actual key string
    last_use_at str
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    name str
    Internal name for the API Key. For your use.
    path str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permission_set str
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    platform str
    If this API key represents a Desktop app, what platform was it created on?
    site_id int
    Site ID
    site_name str
    Site Name
    url str
    URL for API host.
    user_id int
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspace_id int
    Workspace ID for this API Key. 0 means the default workspace.
    awsAccessKeyId String
    AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsSecretKey String
    AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    awsStyleCredentials Boolean
    If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
    createdAt String
    Time which API Key was created
    description String
    User-supplied description of API key.
    descriptiveLabel String
    Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
    expiresAt String
    API Key expiration date
    key String
    API Key actual key string
    lastUseAt String
    API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
    name String
    Internal name for the API Key. For your use.
    path String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Folder path restriction for officeIntegration permission set API keys.
    permissionSet String
    Permissions for this API Key. Keys with the desktopApp permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the officeIntegration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the filesOnly permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
    platform String
    If this API key represents a Desktop app, what platform was it created on?
    siteId Number
    Site ID
    siteName String
    Site Name
    url String
    URL for API host.
    userId Number
    User ID for the owner of this API Key. May be blank for Site-wide API Keys.
    workspaceId Number
    Workspace ID for this API Key. 0 means the default workspace.

    Import

    The pulumi import command can be used, for example:

    Api Keys can be imported by specifying the id.

    $ pulumi import filescom:index/apiKey:ApiKey example_api_key 1

    To learn more about importing existing cloud resources, see Importing resources.

    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