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

filescom.getGpgKey

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

    A GPGKey object on Files.com is used to securely store both the private and public keys associated with a GPG (GNU Privacy Guard) encryption key pair. This object enables the encryption and decryption of data using GPG, allowing you to protect sensitive information.

    The private key is kept confidential and is used for decrypting data or signing messages to prove authenticity, while the public key is used to encrypt messages that only the owner of the private key can decrypt.

    By storing both keys together in a GPGKey object, Files.com makes it easier to understand encryption operations, ensuring secure and efficient handling of encrypted data within the platform.

    Example Usage

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

const exampleGpgKey = filescom.getGpgKey({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_gpg_key = filescom.get_gpg_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.GetGpgKey(ctx, &filescom.LookupGpgKeyArgs{
			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 exampleGpgKey = Filescom.GetGpgKey.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.GetGpgKeyArgs;
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 exampleGpgKey = FilescomFunctions.getGpgKey(GetGpgKeyArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleGpgKey:
    fn::invoke:
      function: filescom:getGpgKey
      arguments:
        id: 1

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

data "filescom_getgpgkey" "exampleGpgKey" {
  id = 1
}

    Using getGpgKey

    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 getGpgKey(args: GetGpgKeyArgs, opts?: InvokeOptions): Promise<GetGpgKeyResult>
function getGpgKeyOutput(args: GetGpgKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetGpgKeyResult>
    def get_gpg_key(id: Optional[int] = None,
                opts: Optional[InvokeOptions] = None) -> GetGpgKeyResult
def get_gpg_key_output(id: pulumi.Input[Optional[int]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetGpgKeyResult]
    func LookupGpgKey(ctx *Context, args *LookupGpgKeyArgs, opts ...InvokeOption) (*LookupGpgKeyResult, error)
func LookupGpgKeyOutput(ctx *Context, args *LookupGpgKeyOutputArgs, opts ...InvokeOption) LookupGpgKeyResultOutput

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

    public static class GetGpgKey 
{
    public static Task<GetGpgKeyResult> InvokeAsync(GetGpgKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetGpgKeyResult> Invoke(GetGpgKeyInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetGpgKeyResult> Invoke(GetGpgKeyInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetGpgKeyResult> getGpgKey(GetGpgKeyArgs args, InvokeOptions options)
public static Output<GetGpgKeyResult> getGpgKey(GetGpgKeyArgs args, InvokeOptions options)
public static Output<GetGpgKeyResult> getGpgKey(GetGpgKeyArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getGpgKey:getGpgKey
  arguments:
    # arguments dictionary
    data "filescom_get_gpg_key" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    GPG key ID.
    Id int
    GPG key ID.
    id number
    GPG key ID.
    id Integer
    GPG key ID.
    id number
    GPG key ID.
    id int
    GPG key ID.
    id Number
    GPG key ID.

    getGpgKey Result

    The following output properties are available:

    ExpiresAt string
    GPG key expiration date.
    GeneratedPrivateKey string
    GPG private key.
    GeneratedPublicKey string
    GPG public key
    Id int
    GPG key ID.
    Name string
    GPG key name.
    PartnerId int
    Partner ID who owns this GPG Key, if applicable.
    PartnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    PrivateKeyMd5 string
    MD5 hash of the GPG private key.
    PrivateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    PublicKeyMd5 string
    MD5 hash of the GPG public key
    UserId int
    User ID who owns this GPG Key, if applicable.
    WorkspaceId int
    Workspace ID (0 for default workspace).
    ExpiresAt string
    GPG key expiration date.
    GeneratedPrivateKey string
    GPG private key.
    GeneratedPublicKey string
    GPG public key
    Id int
    GPG key ID.
    Name string
    GPG key name.
    PartnerId int
    Partner ID who owns this GPG Key, if applicable.
    PartnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    PrivateKeyMd5 string
    MD5 hash of the GPG private key.
    PrivateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    PublicKeyMd5 string
    MD5 hash of the GPG public key
    UserId int
    User ID who owns this GPG Key, if applicable.
    WorkspaceId int
    Workspace ID (0 for default workspace).
    expires_at string
    GPG key expiration date.
    generated_private_key string
    GPG private key.
    generated_public_key string
    GPG public key
    id number
    GPG key ID.
    name string
    GPG key name.
    partner_id number
    Partner ID who owns this GPG Key, if applicable.
    partner_name string
    Name of the Partner who owns this GPG Key, if applicable.
    private_key_md5 string
    MD5 hash of the GPG private key.
    private_key_password_md5 string
    GPG private key password. Only required for password protected keys.
    public_key_md5 string
    MD5 hash of the GPG public key
    user_id number
    User ID who owns this GPG Key, if applicable.
    workspace_id number
    Workspace ID (0 for default workspace).
    expiresAt String
    GPG key expiration date.
    generatedPrivateKey String
    GPG private key.
    generatedPublicKey String
    GPG public key
    id Integer
    GPG key ID.
    name String
    GPG key name.
    partnerId Integer
    Partner ID who owns this GPG Key, if applicable.
    partnerName String
    Name of the Partner who owns this GPG Key, if applicable.
    privateKeyMd5 String
    MD5 hash of the GPG private key.
    privateKeyPasswordMd5 String
    GPG private key password. Only required for password protected keys.
    publicKeyMd5 String
    MD5 hash of the GPG public key
    userId Integer
    User ID who owns this GPG Key, if applicable.
    workspaceId Integer
    Workspace ID (0 for default workspace).
    expiresAt string
    GPG key expiration date.
    generatedPrivateKey string
    GPG private key.
    generatedPublicKey string
    GPG public key
    id number
    GPG key ID.
    name string
    GPG key name.
    partnerId number
    Partner ID who owns this GPG Key, if applicable.
    partnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    privateKeyMd5 string
    MD5 hash of the GPG private key.
    privateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    publicKeyMd5 string
    MD5 hash of the GPG public key
    userId number
    User ID who owns this GPG Key, if applicable.
    workspaceId number
    Workspace ID (0 for default workspace).
    expires_at str
    GPG key expiration date.
    generated_private_key str
    GPG private key.
    generated_public_key str
    GPG public key
    id int
    GPG key ID.
    name str
    GPG key name.
    partner_id int
    Partner ID who owns this GPG Key, if applicable.
    partner_name str
    Name of the Partner who owns this GPG Key, if applicable.
    private_key_md5 str
    MD5 hash of the GPG private key.
    private_key_password_md5 str
    GPG private key password. Only required for password protected keys.
    public_key_md5 str
    MD5 hash of the GPG public key
    user_id int
    User ID who owns this GPG Key, if applicable.
    workspace_id int
    Workspace ID (0 for default workspace).
    expiresAt String
    GPG key expiration date.
    generatedPrivateKey String
    GPG private key.
    generatedPublicKey String
    GPG public key
    id Number
    GPG key ID.
    name String
    GPG key name.
    partnerId Number
    Partner ID who owns this GPG Key, if applicable.
    partnerName String
    Name of the Partner who owns this GPG Key, if applicable.
    privateKeyMd5 String
    MD5 hash of the GPG private key.
    privateKeyPasswordMd5 String
    GPG private key password. Only required for password protected keys.
    publicKeyMd5 String
    MD5 hash of the GPG public key
    userId Number
    User ID who owns this GPG Key, if applicable.
    workspaceId Number
    Workspace ID (0 for 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