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

filescom.getApiKey

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 = filescom.getApiKey({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_api_key = filescom.get_api_key(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.GetApiKey(ctx, &filescom.LookupApiKeyArgs{
			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 exampleApiKey = Filescom.GetApiKey.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.GetApiKeyArgs;
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 exampleApiKey = FilescomFunctions.getApiKey(GetApiKeyArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleApiKey:
    fn::invoke:
      function: filescom:getApiKey
      arguments:
        id: 1

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

data "filescom_getapikey" "exampleApiKey" {
  id = 1
}

    Using getApiKey

    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 getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetApiKeyResult>
    def get_api_key(id: Optional[int] = None,
                opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
def get_api_key_output(id: pulumi.Input[Optional[int]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetApiKeyResult]
    func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput

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

    public static class GetApiKey 
{
    public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
public static Output<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
public static Output<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getApiKey:getApiKey
  arguments:
    # arguments dictionary
    data "filescom_get_api_key" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    API Key ID
    Id int
    API Key ID
    id number
    API Key ID
    id Integer
    API Key ID
    id number
    API Key ID
    id int
    API Key ID
    id Number
    API Key ID

    getApiKey Result

    The following output properties are available:

    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
    Id int
    API Key ID
    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.
    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
    Id int
    API Key ID
    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.
    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
    id number
    API Key ID
    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.
    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
    id Integer
    API Key ID
    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.
    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
    id number
    API Key ID
    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.
    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
    id int
    API Key ID
    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.
    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
    id Number
    API Key ID
    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.
    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.

    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