1. Packages
  2. Packages
  3. Gcore Provider
  4. API Docs
  5. getStorageSftps
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 exampleStorageSftps = gcore.getStorageSftps({
        id: "id",
        locationName: "location_name",
        name: "name",
        provisioningStatus: "active",
        showDeleted: true,
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    example_storage_sftps = gcore.get_storage_sftps(id="id",
        location_name="location_name",
        name="name",
        provisioning_status="active",
        show_deleted=True)
    
    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.GetStorageSftps(ctx, &gcore.GetStorageSftpsArgs{
    			Id:                 pulumi.StringRef("id"),
    			LocationName:       pulumi.StringRef("location_name"),
    			Name:               pulumi.StringRef("name"),
    			ProvisioningStatus: pulumi.StringRef("active"),
    			ShowDeleted:        pulumi.BoolRef(true),
    		}, 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 exampleStorageSftps = Gcore.GetStorageSftps.Invoke(new()
        {
            Id = "id",
            LocationName = "location_name",
            Name = "name",
            ProvisioningStatus = "active",
            ShowDeleted = true,
        });
    
    });
    
    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.GetStorageSftpsArgs;
    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 exampleStorageSftps = GcoreFunctions.getStorageSftps(GetStorageSftpsArgs.builder()
                .id("id")
                .locationName("location_name")
                .name("name")
                .provisioningStatus("active")
                .showDeleted(true)
                .build());
    
        }
    }
    
    variables:
      exampleStorageSftps:
        fn::invoke:
          function: gcore:getStorageSftps
          arguments:
            id: id
            locationName: location_name
            name: name
            provisioningStatus: active
            showDeleted: true
    
    Example coming soon!
    

    Using getStorageSftps

    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 getStorageSftps(args: GetStorageSftpsArgs, opts?: InvokeOptions): Promise<GetStorageSftpsResult>
    function getStorageSftpsOutput(args: GetStorageSftpsOutputArgs, opts?: InvokeOptions): Output<GetStorageSftpsResult>
    def get_storage_sftps(id: Optional[str] = None,
                          location_name: Optional[str] = None,
                          max_items: Optional[float] = None,
                          name: Optional[str] = None,
                          order_by: Optional[str] = None,
                          provisioning_status: Optional[str] = None,
                          show_deleted: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetStorageSftpsResult
    def get_storage_sftps_output(id: pulumi.Input[Optional[str]] = None,
                          location_name: pulumi.Input[Optional[str]] = None,
                          max_items: pulumi.Input[Optional[float]] = None,
                          name: pulumi.Input[Optional[str]] = None,
                          order_by: pulumi.Input[Optional[str]] = None,
                          provisioning_status: pulumi.Input[Optional[str]] = None,
                          show_deleted: pulumi.Input[Optional[bool]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetStorageSftpsResult]
    func GetStorageSftps(ctx *Context, args *GetStorageSftpsArgs, opts ...InvokeOption) (*GetStorageSftpsResult, error)
    func GetStorageSftpsOutput(ctx *Context, args *GetStorageSftpsOutputArgs, opts ...InvokeOption) GetStorageSftpsResultOutput

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

    public static class GetStorageSftps 
    {
        public static Task<GetStorageSftpsResult> InvokeAsync(GetStorageSftpsArgs args, InvokeOptions? opts = null)
        public static Output<GetStorageSftpsResult> Invoke(GetStorageSftpsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStorageSftpsResult> getStorageSftps(GetStorageSftpsArgs args, InvokeOptions options)
    public static Output<GetStorageSftpsResult> getStorageSftps(GetStorageSftpsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getStorageSftps:getStorageSftps
      arguments:
        # arguments dictionary
    data "gcore_getstoragesftps" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Filter by storage ID
    LocationName string
    Filter by storage location/region
    MaxItems double
    Max items to fetch, default: 1000
    Name string
    Filter by storage name
    OrderBy string
    ProvisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    ShowDeleted bool
    Include deleted storages
    Id string
    Filter by storage ID
    LocationName string
    Filter by storage location/region
    MaxItems float64
    Max items to fetch, default: 1000
    Name string
    Filter by storage name
    OrderBy string
    ProvisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    ShowDeleted bool
    Include deleted storages
    id string
    Filter by storage ID
    location_name string
    Filter by storage location/region
    max_items number
    Max items to fetch, default: 1000
    name string
    Filter by storage name
    order_by string
    provisioning_status string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    show_deleted bool
    Include deleted storages
    id String
    Filter by storage ID
    locationName String
    Filter by storage location/region
    maxItems Double
    Max items to fetch, default: 1000
    name String
    Filter by storage name
    orderBy String
    provisioningStatus String
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted Boolean
    Include deleted storages
    id string
    Filter by storage ID
    locationName string
    Filter by storage location/region
    maxItems number
    Max items to fetch, default: 1000
    name string
    Filter by storage name
    orderBy string
    provisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted boolean
    Include deleted storages
    id str
    Filter by storage ID
    location_name str
    Filter by storage location/region
    max_items float
    Max items to fetch, default: 1000
    name str
    Filter by storage name
    order_by str
    provisioning_status str
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    show_deleted bool
    Include deleted storages
    id String
    Filter by storage ID
    locationName String
    Filter by storage location/region
    maxItems Number
    Max items to fetch, default: 1000
    name String
    Filter by storage name
    orderBy String
    provisioningStatus String
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted Boolean
    Include deleted storages

    getStorageSftps Result

    The following output properties are available:

    Items List<GetStorageSftpsItem>
    The items returned by the data source
    OrderBy string
    Id string
    Filter by storage ID
    LocationName string
    Filter by storage location/region
    MaxItems double
    Max items to fetch, default: 1000
    Name string
    Filter by storage name
    ProvisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    ShowDeleted bool
    Include deleted storages
    Items []GetStorageSftpsItem
    The items returned by the data source
    OrderBy string
    Id string
    Filter by storage ID
    LocationName string
    Filter by storage location/region
    MaxItems float64
    Max items to fetch, default: 1000
    Name string
    Filter by storage name
    ProvisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    ShowDeleted bool
    Include deleted storages
    items list(object)
    The items returned by the data source
    order_by string
    id string
    Filter by storage ID
    location_name string
    Filter by storage location/region
    max_items number
    Max items to fetch, default: 1000
    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
    items List<GetStorageSftpsItem>
    The items returned by the data source
    orderBy String
    id String
    Filter by storage ID
    locationName String
    Filter by storage location/region
    maxItems Double
    Max items to fetch, default: 1000
    name String
    Filter by storage name
    provisioningStatus String
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted Boolean
    Include deleted storages
    items GetStorageSftpsItem[]
    The items returned by the data source
    orderBy string
    id string
    Filter by storage ID
    locationName string
    Filter by storage location/region
    maxItems number
    Max items to fetch, default: 1000
    name string
    Filter by storage name
    provisioningStatus string
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted boolean
    Include deleted storages
    items Sequence[GetStorageSftpsItem]
    The items returned by the data source
    order_by str
    id str
    Filter by storage ID
    location_name str
    Filter by storage location/region
    max_items float
    Max items to fetch, default: 1000
    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
    items List<Property Map>
    The items returned by the data source
    orderBy String
    id String
    Filter by storage ID
    locationName String
    Filter by storage location/region
    maxItems Number
    Max items to fetch, default: 1000
    name String
    Filter by storage name
    provisioningStatus String
    Filter by provisioning status Available values: "active", "creating", "updating", "deleting", "deleted".
    showDeleted Boolean
    Include deleted storages

    Supporting Types

    GetStorageSftpsItem

    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
    Unique identifier for the storage instance
    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
    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
    Unique identifier for the storage instance
    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
    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
    Unique identifier for the storage instance
    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
    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
    Unique identifier for the storage instance
    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
    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
    Unique identifier for the storage instance
    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
    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
    Unique identifier for the storage instance
    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
    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
    Unique identifier for the storage instance
    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

    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