1. Packages
  2. Packages
  3. Supabase Provider
  4. API Docs
  5. EdgeFunctionSecrets
Viewing docs for supabase 1.9.0
published on Wednesday, Apr 8, 2026 by supabase
supabase logo
Viewing docs for supabase 1.9.0
published on Wednesday, Apr 8, 2026 by supabase

    Import

    The pulumi import command can be used, for example:

    Edge function secrets can be imported using the project reference.

    • project_ref: Found in the Supabase dashboard under Project Settings -> General,

      or in the project’s URL: https://supabase.com/dashboard/project/<project_ref>

    IMPORTANT: The Supabase management API only returns SHA-256 digests of secret

    values, never the plaintext. After import:

    • secret_digests is populated with the digests returned by the API.

    • secrets[*].value is null for every imported secret.

    • Secrets with a SUPABASE_ prefix are not imported (they are reserved).

    After running this command, supply the plaintext secret values in your Terraform

    configuration and run pulumi preview to reconcile state. Terraform will show

    a plan to update the secrets to match the values in your config.

    Note: Secret values are sensitive. Always use a remote state backend with

    encryption to protect sensitive values stored in Terraform state.

    $ pulumi import supabase:index/edgeFunctionSecrets:EdgeFunctionSecrets example mayuaycdtijbctgqbycg
    

    Create EdgeFunctionSecrets Resource

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

    Constructor syntax

    new EdgeFunctionSecrets(name: string, args: EdgeFunctionSecretsArgs, opts?: CustomResourceOptions);
    @overload
    def EdgeFunctionSecrets(resource_name: str,
                            args: EdgeFunctionSecretsArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def EdgeFunctionSecrets(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project_ref: Optional[str] = None,
                            secrets: Optional[Sequence[EdgeFunctionSecretsSecretArgs]] = None)
    func NewEdgeFunctionSecrets(ctx *Context, name string, args EdgeFunctionSecretsArgs, opts ...ResourceOption) (*EdgeFunctionSecrets, error)
    public EdgeFunctionSecrets(string name, EdgeFunctionSecretsArgs args, CustomResourceOptions? opts = null)
    public EdgeFunctionSecrets(String name, EdgeFunctionSecretsArgs args)
    public EdgeFunctionSecrets(String name, EdgeFunctionSecretsArgs args, CustomResourceOptions options)
    
    type: supabase:EdgeFunctionSecrets
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EdgeFunctionSecretsArgs
    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 EdgeFunctionSecretsArgs
    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 EdgeFunctionSecretsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeFunctionSecretsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeFunctionSecretsArgs
    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 edgeFunctionSecretsResource = new Supabase.EdgeFunctionSecrets("edgeFunctionSecretsResource", new()
    {
        ProjectRef = "string",
        Secrets = new[]
        {
            new Supabase.Inputs.EdgeFunctionSecretsSecretArgs
            {
                Name = "string",
                Value = "string",
            },
        },
    });
    
    example, err := supabase.NewEdgeFunctionSecrets(ctx, "edgeFunctionSecretsResource", &supabase.EdgeFunctionSecretsArgs{
    	ProjectRef: pulumi.String("string"),
    	Secrets: supabase.EdgeFunctionSecretsSecretArray{
    		&supabase.EdgeFunctionSecretsSecretArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    var edgeFunctionSecretsResource = new EdgeFunctionSecrets("edgeFunctionSecretsResource", EdgeFunctionSecretsArgs.builder()
        .projectRef("string")
        .secrets(EdgeFunctionSecretsSecretArgs.builder()
            .name("string")
            .value("string")
            .build())
        .build());
    
    edge_function_secrets_resource = supabase.EdgeFunctionSecrets("edgeFunctionSecretsResource",
        project_ref="string",
        secrets=[{
            "name": "string",
            "value": "string",
        }])
    
    const edgeFunctionSecretsResource = new supabase.EdgeFunctionSecrets("edgeFunctionSecretsResource", {
        projectRef: "string",
        secrets: [{
            name: "string",
            value: "string",
        }],
    });
    
    type: supabase:EdgeFunctionSecrets
    properties:
        projectRef: string
        secrets:
            - name: string
              value: string
    

    EdgeFunctionSecrets 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 EdgeFunctionSecrets resource accepts the following input properties:

    ProjectRef string
    Project reference ID
    Secrets List<EdgeFunctionSecretsSecret>
    Set of secrets for edge functions
    ProjectRef string
    Project reference ID
    Secrets []EdgeFunctionSecretsSecretArgs
    Set of secrets for edge functions
    projectRef String
    Project reference ID
    secrets List<EdgeFunctionSecretsSecret>
    Set of secrets for edge functions
    projectRef string
    Project reference ID
    secrets EdgeFunctionSecretsSecret[]
    Set of secrets for edge functions
    project_ref str
    Project reference ID
    secrets Sequence[EdgeFunctionSecretsSecretArgs]
    Set of secrets for edge functions
    projectRef String
    Project reference ID
    secrets List<Property Map>
    Set of secrets for edge functions

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SecretDigests Dictionary<string, string>
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretDigests map[string]string
    id String
    The provider-assigned unique ID for this managed resource.
    secretDigests Map<String,String>
    id string
    The provider-assigned unique ID for this managed resource.
    secretDigests {[key: string]: string}
    id str
    The provider-assigned unique ID for this managed resource.
    secret_digests Mapping[str, str]
    id String
    The provider-assigned unique ID for this managed resource.
    secretDigests Map<String>

    Look up Existing EdgeFunctionSecrets Resource

    Get an existing EdgeFunctionSecrets 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?: EdgeFunctionSecretsState, opts?: CustomResourceOptions): EdgeFunctionSecrets
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            project_ref: Optional[str] = None,
            secret_digests: Optional[Mapping[str, str]] = None,
            secrets: Optional[Sequence[EdgeFunctionSecretsSecretArgs]] = None) -> EdgeFunctionSecrets
    func GetEdgeFunctionSecrets(ctx *Context, name string, id IDInput, state *EdgeFunctionSecretsState, opts ...ResourceOption) (*EdgeFunctionSecrets, error)
    public static EdgeFunctionSecrets Get(string name, Input<string> id, EdgeFunctionSecretsState? state, CustomResourceOptions? opts = null)
    public static EdgeFunctionSecrets get(String name, Output<String> id, EdgeFunctionSecretsState state, CustomResourceOptions options)
    resources:  _:    type: supabase:EdgeFunctionSecrets    get:      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:
    ProjectRef string
    Project reference ID
    SecretDigests Dictionary<string, string>
    Secrets List<EdgeFunctionSecretsSecret>
    Set of secrets for edge functions
    ProjectRef string
    Project reference ID
    SecretDigests map[string]string
    Secrets []EdgeFunctionSecretsSecretArgs
    Set of secrets for edge functions
    projectRef String
    Project reference ID
    secretDigests Map<String,String>
    secrets List<EdgeFunctionSecretsSecret>
    Set of secrets for edge functions
    projectRef string
    Project reference ID
    secretDigests {[key: string]: string}
    secrets EdgeFunctionSecretsSecret[]
    Set of secrets for edge functions
    project_ref str
    Project reference ID
    secret_digests Mapping[str, str]
    secrets Sequence[EdgeFunctionSecretsSecretArgs]
    Set of secrets for edge functions
    projectRef String
    Project reference ID
    secretDigests Map<String>
    secrets List<Property Map>
    Set of secrets for edge functions

    Supporting Types

    EdgeFunctionSecretsSecret, EdgeFunctionSecretsSecretArgs

    Name string
    Name of the secret. Must not start with the SUPABASE_ prefix — such names are reserved internally by Supabase, cannot be created, updated, or deleted via the API, and are automatically filtered out from reads and imports.
    Value string
    Name string
    Name of the secret. Must not start with the SUPABASE_ prefix — such names are reserved internally by Supabase, cannot be created, updated, or deleted via the API, and are automatically filtered out from reads and imports.
    Value string
    name String
    Name of the secret. Must not start with the SUPABASE_ prefix — such names are reserved internally by Supabase, cannot be created, updated, or deleted via the API, and are automatically filtered out from reads and imports.
    value String
    name string
    Name of the secret. Must not start with the SUPABASE_ prefix — such names are reserved internally by Supabase, cannot be created, updated, or deleted via the API, and are automatically filtered out from reads and imports.
    value string
    name str
    Name of the secret. Must not start with the SUPABASE_ prefix — such names are reserved internally by Supabase, cannot be created, updated, or deleted via the API, and are automatically filtered out from reads and imports.
    value str
    name String
    Name of the secret. Must not start with the SUPABASE_ prefix — such names are reserved internally by Supabase, cannot be created, updated, or deleted via the API, and are automatically filtered out from reads and imports.
    value String

    Package Details

    Repository
    supabase supabase/terraform-provider-supabase
    License
    Notes
    This Pulumi package is based on the supabase Terraform Provider.
    supabase logo
    Viewing docs for supabase 1.9.0
    published on Wednesday, Apr 8, 2026 by supabase
      Try Pulumi Cloud free. Your team will thank you.