1. Packages
  2. Packages
  3. Gcore Provider
  4. API Docs
  5. getStorageSftp
Viewing docs for gcore 2.0.0-alpha.8
published on Wednesday, May 20, 2026 by g-core
Viewing docs for gcore 2.0.0-alpha.8
published on Wednesday, May 20, 2026 by g-core

    SFTP storages provide file transfer protocol access for securely uploading, downloading, and managing files over SSH.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const exampleStorageSftp = gcore.getStorageSftp({
        storageId: 0,
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    example_storage_sftp = gcore.get_storage_sftp(storage_id=0)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gcore.LookupStorageSftp(ctx, &gcore.LookupStorageSftpArgs{
    			StorageId: pulumi.Float64Ref(0),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleStorageSftp = Gcore.GetStorageSftp.Invoke(new()
        {
            StorageId = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetStorageSftpArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 exampleStorageSftp = GcoreFunctions.getStorageSftp(GetStorageSftpArgs.builder()
                .storageId(0)
                .build());
    
        }
    }
    
    variables:
      exampleStorageSftp:
        fn::invoke:
          function: gcore:getStorageSftp
          arguments:
            storageId: 0
    
    Example coming soon!
    

    Using getStorageSftp

    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 getStorageSftp(args: GetStorageSftpArgs, opts?: InvokeOptions): Promise<GetStorageSftpResult>
    function getStorageSftpOutput(args: GetStorageSftpOutputArgs, opts?: InvokeOptions): Output<GetStorageSftpResult>
    def get_storage_sftp(find_one_by: Optional[GetStorageSftpFindOneBy] = None,
                         storage_id: Optional[float] = None,
                         opts: Optional[InvokeOptions] = None) -> GetStorageSftpResult
    def get_storage_sftp_output(find_one_by: pulumi.Input[Optional[GetStorageSftpFindOneByArgs]] = None,
                         storage_id: pulumi.Input[Optional[float]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetStorageSftpResult]
    func LookupStorageSftp(ctx *Context, args *LookupStorageSftpArgs, opts ...InvokeOption) (*LookupStorageSftpResult, error)
    func LookupStorageSftpOutput(ctx *Context, args *LookupStorageSftpOutputArgs, opts ...InvokeOption) LookupStorageSftpResultOutput

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

    public static class GetStorageSftp 
    {
        public static Task<GetStorageSftpResult> InvokeAsync(GetStorageSftpArgs args, InvokeOptions? opts = null)
        public static Output<GetStorageSftpResult> Invoke(GetStorageSftpInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStorageSftpResult> getStorageSftp(GetStorageSftpArgs args, InvokeOptions options)
    public static Output<GetStorageSftpResult> getStorageSftp(GetStorageSftpArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getStorageSftp:getStorageSftp
      arguments:
        # arguments dictionary
    data "gcore_getstoragesftp" "name" {
        # arguments
    }

    The following arguments are supported:

    getStorageSftp Result

    The following output properties are available:

    Address string
    Full hostname/address for accessing the storage endpoint
    CreatedAt string
    ISO 8601 timestamp when the storage was created
    Expires string
    Duration when the storage will expire. Null if no expiration is set.
    FullName string
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    HasCustomConfigFile bool
    Whether this storage uses a custom configuration file
    HasPassword bool
    Whether password authentication is configured for this storage
    Id double
    The ID of this resource.
    IsHttpDisabled bool
    Whether HTTP access is disabled for this storage (HTTPS only)
    LocationName string
    Geographic location code where the storage is provisioned
    Name string
    User-defined name for the storage instance, as supplied at creation time.
    Password string
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    ProvisioningStatus string
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    ServerAlias string
    Custom domain alias for accessing the storage. Null if no alias is configured.
    SshKeyIds List<double>
    IDs of SSH keys associated with this SFTP storage
    FindOneBy GetStorageSftpFindOneBy
    StorageId double
    Address string
    Full hostname/address for accessing the storage endpoint
    CreatedAt string
    ISO 8601 timestamp when the storage was created
    Expires string
    Duration when the storage will expire. Null if no expiration is set.
    FullName string
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    HasCustomConfigFile bool
    Whether this storage uses a custom configuration file
    HasPassword bool
    Whether password authentication is configured for this storage
    Id float64
    The ID of this resource.
    IsHttpDisabled bool
    Whether HTTP access is disabled for this storage (HTTPS only)
    LocationName string
    Geographic location code where the storage is provisioned
    Name string
    User-defined name for the storage instance, as supplied at creation time.
    Password string
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    ProvisioningStatus string
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    ServerAlias string
    Custom domain alias for accessing the storage. Null if no alias is configured.
    SshKeyIds []float64
    IDs of SSH keys associated with this SFTP storage
    FindOneBy GetStorageSftpFindOneBy
    StorageId float64
    address string
    Full hostname/address for accessing the storage endpoint
    created_at string
    ISO 8601 timestamp when the storage was created
    expires string
    Duration when the storage will expire. Null if no expiration is set.
    full_name string
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    has_custom_config_file bool
    Whether this storage uses a custom configuration file
    has_password bool
    Whether password authentication is configured for this storage
    id number
    The ID of this resource.
    is_http_disabled bool
    Whether HTTP access is disabled for this storage (HTTPS only)
    location_name string
    Geographic location code where the storage is provisioned
    name string
    User-defined name for the storage instance, as supplied at creation time.
    password string
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    provisioning_status string
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    server_alias string
    Custom domain alias for accessing the storage. Null if no alias is configured.
    ssh_key_ids list(number)
    IDs of SSH keys associated with this SFTP storage
    find_one_by object
    storage_id number
    address String
    Full hostname/address for accessing the storage endpoint
    createdAt String
    ISO 8601 timestamp when the storage was created
    expires String
    Duration when the storage will expire. Null if no expiration is set.
    fullName String
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    hasCustomConfigFile Boolean
    Whether this storage uses a custom configuration file
    hasPassword Boolean
    Whether password authentication is configured for this storage
    id Double
    The ID of this resource.
    isHttpDisabled Boolean
    Whether HTTP access is disabled for this storage (HTTPS only)
    locationName String
    Geographic location code where the storage is provisioned
    name String
    User-defined name for the storage instance, as supplied at creation time.
    password String
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    provisioningStatus String
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    serverAlias String
    Custom domain alias for accessing the storage. Null if no alias is configured.
    sshKeyIds List<Double>
    IDs of SSH keys associated with this SFTP storage
    findOneBy GetStorageSftpFindOneBy
    storageId Double
    address string
    Full hostname/address for accessing the storage endpoint
    createdAt string
    ISO 8601 timestamp when the storage was created
    expires string
    Duration when the storage will expire. Null if no expiration is set.
    fullName string
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    hasCustomConfigFile boolean
    Whether this storage uses a custom configuration file
    hasPassword boolean
    Whether password authentication is configured for this storage
    id number
    The ID of this resource.
    isHttpDisabled boolean
    Whether HTTP access is disabled for this storage (HTTPS only)
    locationName string
    Geographic location code where the storage is provisioned
    name string
    User-defined name for the storage instance, as supplied at creation time.
    password string
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    provisioningStatus string
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    serverAlias string
    Custom domain alias for accessing the storage. Null if no alias is configured.
    sshKeyIds number[]
    IDs of SSH keys associated with this SFTP storage
    findOneBy GetStorageSftpFindOneBy
    storageId number
    address str
    Full hostname/address for accessing the storage endpoint
    created_at str
    ISO 8601 timestamp when the storage was created
    expires str
    Duration when the storage will expire. Null if no expiration is set.
    full_name str
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    has_custom_config_file bool
    Whether this storage uses a custom configuration file
    has_password bool
    Whether password authentication is configured for this storage
    id float
    The ID of this resource.
    is_http_disabled bool
    Whether HTTP access is disabled for this storage (HTTPS only)
    location_name str
    Geographic location code where the storage is provisioned
    name str
    User-defined name for the storage instance, as supplied at creation time.
    password str
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    provisioning_status str
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    server_alias str
    Custom domain alias for accessing the storage. Null if no alias is configured.
    ssh_key_ids Sequence[float]
    IDs of SSH keys associated with this SFTP storage
    find_one_by GetStorageSftpFindOneBy
    storage_id float
    address String
    Full hostname/address for accessing the storage endpoint
    createdAt String
    ISO 8601 timestamp when the storage was created
    expires String
    Duration when the storage will expire. Null if no expiration is set.
    fullName String
    Read-only internal full name of the storage, composed as "{client_id}-{name}". Used by the SFTP backend as the login username. Clients should use this value when connecting but should continue to identify the storage by name in their own configuration.
    hasCustomConfigFile Boolean
    Whether this storage uses a custom configuration file
    hasPassword Boolean
    Whether password authentication is configured for this storage
    id Number
    The ID of this resource.
    isHttpDisabled Boolean
    Whether HTTP access is disabled for this storage (HTTPS only)
    locationName String
    Geographic location code where the storage is provisioned
    name String
    User-defined name for the storage instance, as supplied at creation time.
    password String
    SFTP password. Only returned when newly generated or set (create/patch). Omitted in GET/list responses.
    provisioningStatus String
    Lifecycle status of the storage. Use this to check readiness before operations. Available values: "creating", "active", "updating", "deleting", "deleted".
    serverAlias String
    Custom domain alias for accessing the storage. Null if no alias is configured.
    sshKeyIds List<Number>
    IDs of SSH keys associated with this SFTP storage
    findOneBy Property Map
    storageId Number

    Supporting Types

    GetStorageSftpFindOneBy

    OrderBy string
    Id string
    Filter by storage ID
    LocationName string
    Filter by storage location/region
    Name string
    Filter by storage name
    ProvisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    ShowDeleted bool
    Include deleted storages
    OrderBy string
    Id string
    Filter by storage ID
    LocationName string
    Filter by storage location/region
    Name string
    Filter by storage name
    ProvisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    ShowDeleted bool
    Include deleted storages
    order_by string
    id string
    Filter by storage ID
    location_name string
    Filter by storage location/region
    name string
    Filter by storage name
    provisioning_status string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    show_deleted bool
    Include deleted storages
    orderBy String
    id String
    Filter by storage ID
    locationName String
    Filter by storage location/region
    name String
    Filter by storage name
    provisioningStatus String
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted Boolean
    Include deleted storages
    orderBy string
    id string
    Filter by storage ID
    locationName string
    Filter by storage location/region
    name string
    Filter by storage name
    provisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted boolean
    Include deleted storages
    order_by str
    id str
    Filter by storage ID
    location_name str
    Filter by storage location/region
    name str
    Filter by storage name
    provisioning_status str
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    show_deleted bool
    Include deleted storages
    orderBy String
    id String
    Filter by storage ID
    locationName String
    Filter by storage location/region
    name String
    Filter by storage name
    provisioningStatus String
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted Boolean
    Include deleted storages

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    Viewing docs for gcore 2.0.0-alpha.8
    published on Wednesday, May 20, 2026 by g-core

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial