Delete a parameter

This page describes how to delete a parameter. You must review your parameters periodically to identify those that are no longer necessary. Parameters might become outdated or unnecessary in the following circumstances:

  • When they are no longer being used by any application, service, or configuration.
  • When they are being used by earlier versions of applications that are no longer in use.
  • In the event of a security breach, any potentially compromised parameters should be deleted.

You can only delete parameters that have no active versions (enabled or disabled) associated with it.

Required roles

To get the permissions that you need to delete a parameter, ask your administrator to grant you the Parameter Manager Admin (roles/parametermanager.admin) IAM role on the project, folder, or organization. For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Delete a parameter

To delete a parameter, use one of the following methods:

Global parameters

Console

  1. In the Google Cloud console, go to the Secret Manager page.

    Go to Secret Manager

  2. Click Parameter Manager to go to the Parameter Manager page. You'll see the list of parameters for that project.

  3. Click the Actions menu associated with the parameter that you want to delete, and then click Delete.

  4. In the confirmation dialog that appears, enter the name of the parameter, and click Delete. Note that you can't delete multiple parameters at a time. You also can't delete parameters that have versions.

gcloud

Before using any of the command data below, make the following replacements:

  • PARAMETER_ID: the name of the parameter

Execute the following command:

Linux, macOS, or Cloud Shell

gcloudparametermanagerparametersdeletePARAMETER_ID--location=global

Windows (PowerShell)

gcloudparametermanagerparametersdeletePARAMETER_ID--location=global

Windows (cmd.exe)

gcloudparametermanagerparametersdeletePARAMETER_ID--location=global

You should receive a response similar to the following:

You are about to delete parameter [app_config]
Do you want to continue (Y/n)? y
Deleted parameter [app_config].

REST

Before using any of the request data, make the following replacements:

  • PROJECT_ID: the Google Cloud project ID
  • PARAMETER_ID: the name of the parameter

HTTP method and URL:

DELETE https://parametermanager.googleapis.com/v1/projects/PROJECT_ID/locations/global/parameters/PARAMETER_ID

Request JSON body:

{}

To send your request, choose one of these options:

curl

Save the request body in a file named request.json, and execute the following command:

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://parametermanager.googleapis.com/v1/projects/PROJECT_ID/locations/global/parameters/PARAMETER_ID"

PowerShell

Save the request body in a file named request.json, and execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://parametermanager.googleapis.com/v1/projects/PROJECT_ID/locations/global/parameters/PARAMETER_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{}

C#

To run this code, first set up a C# development environment and install the Parameter Manager C# SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.


usingGoogle.Cloud.ParameterManager.V1 ;
publicclassDeleteParameterSample
{
/// <summary>
/// This function deletes a parameter using the Parameter Manager SDK for GCP.
/// </summary>
/// <param name="projectId">The ID of the project where the parameter is located.</param>
/// <param name="parameterId">The ID of the parameter to be deleted.</param>
publicvoidDeleteParameter(
stringprojectId,
stringparameterId)
{
// Create the client.
ParameterManagerClient client=ParameterManagerClient .Create ();
// Build the resource name for the parameter.
ParameterName parameterName=newParameterName (projectId,"global",parameterId);
// Call the API to delete the parameter.
client.DeleteParameter (parameterName);
// Print a confirmation message.
Console.WriteLine($"Deleted parameter: {parameterName}");
}
}

Go

To run this code, first set up a Go development environment and install the Parameter Manager Go SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

import(
"context"
"fmt"
"io"
parametermanager"cloud.google.com/go/parametermanager/apiv1"
parametermanagerpb"cloud.google.com/go/parametermanager/apiv1/parametermanagerpb"
)
// deleteParam deletes a parameter using the Parameter Manager SDK for GCP.
//
// w: The io.Writer object used to write the output.
// projectID: The ID of the project where the parameter is located.
// parameterID: The ID of the parameter to be deleted.
//
// The function returns an error if the parameter deletion fails.
funcdeleteParam(wio.Writer,projectID,parameterIDstring)error{
// Create a new context.
ctx:=context.Background()
// Initialize a Parameter Manager client.
client,err:=parametermanager.NewClient (ctx)
iferr!=nil{
returnfmt.Errorf("failed to create Parameter Manager client: %w",err)
}
deferclient.Close ()
// Construct the name of the parameter to delete.
name:=fmt.Sprintf("projects/%s/locations/global/parameters/%s",projectID,parameterID)
// Build the request to delete the parameter.
req:=&parametermanagerpb.DeleteParameterRequest{
Name:name,
}
// Call the API to delete the parameter.
err=client.DeleteParameter(ctx,req)
iferr!=nil{
returnfmt.Errorf("failed to delete parameter: %w",err)
}
fmt.Fprintf(w,"Deleted parameter: %s\n",name)
returnnil
}

Java

To run this code, first set up a Java development environment and install the Parameter Manager Java SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.


importcom.google.cloud.parametermanager.v1.ParameterManagerClient ;
importcom.google.cloud.parametermanager.v1.ParameterName ;
importjava.io.IOException;
/** This class demonstrates how to delete a parameter using the Parameter Manager SDK for GCP. */
publicclass DeleteParam{
publicstaticvoidmain(String[]args)throwsIOException{
// TODO(developer): Replace these variables before running the sample.
StringprojectId="your-project-id";
StringparameterId="your-parameter-id";
// Call the method to delete a parameter.
deleteParam(projectId,parameterId);
}
// This is an example snippet for deleting a parameter.
publicstaticvoiddeleteParam(StringprojectId,StringparameterId)throwsIOException{
// Initialize the client that will be used to send requests. This client only
// needs to be created once, and can be reused for multiple requests.
try(ParameterManagerClient client=ParameterManagerClient .create()){
StringlocationId="global";
// Build the parameter name.
ParameterName parameterName=ParameterName .of(projectId,locationId,parameterId);
// Delete the parameter.
client.deleteParameter(parameterName);
System.out.printf("Deleted parameter: %s\n",parameterName.toString ());
}
}
}

Node.js

To run this code, first set up a Node.js development environment and install the Parameter Manager Node.js SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'my-project';
// const parameterId = 'my-parameter';
// Imports the Parameter Manager library
const{ParameterManagerClient}=require('@google-cloud/parametermanager');
// Instantiates a client
constclient=newParameterManagerClient ();
asyncfunctiondeleteParam(){
// Construct the fully qualified parameter name
constname=client.parameterPath (projectId,'global',parameterId);
// Delete the parameter
awaitclient.deleteParameter({
name:name,
});
console.log(`Deleted parameter: ${name}`);
returnname;
}
returnawaitdeleteParam();

PHP

To run this code, first learn about using PHP on Google Cloud and install the Parameter Manager PHP SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

// Import necessary classes for delete a parameter.
use Google\Cloud\ParameterManager\V1\Client\ParameterManagerClient;
use Google\Cloud\ParameterManager\V1\DeleteParameterRequest;
/**
 * Deletes a parameter using the Parameter Manager SDK for GCP.
 *
 * @param string $projectId The Google Cloud Project ID (e.g. 'my-project')
 * @param string $parameterId The Parameter ID (e.g. 'my-param')
 */
function delete_param(string $projectId, string $parameterId): void
{
 // Create a client for the Parameter Manager service.
 $client = new ParameterManagerClient();
 // Build the resource name of the paramete.
 $parameterName = $client->parameterName($projectId, 'global', $parameterId);
 // Prepare the request to delete the parameter.
 $request = (new DeleteParameterRequest())
 ->setName($parameterName);
 // Delete the parameter using the client.
 $client->deleteParameter($request);
 printf('Deleted parameter: %s' . PHP_EOL, $parameterId);
}

Python

To run this code, first set up a Python development environment and install the Parameter Manager Python SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

defdelete_param(project_id: str, parameter_id: str) -> None:
"""
 Deletes a parameter from the global location of the specified
 project using the Google Cloud Parameter Manager SDK.
 Args:
 project_id (str): The ID of the project
 where the parameter is located.
 parameter_id (str): The ID of the parameter to delete.
 Returns:
 None
 Example:
 delete_param(
 "my-project",
 "my-global-parameter"
 )
 """
 # Import the necessary library for Google Cloud Parameter Manager.
 fromgoogle.cloudimport parametermanager_v1
 # Create the Parameter Manager client.
 client = parametermanager_v1 .ParameterManagerClient ()
 # Build the resource name of the parameter.
 name = client.parameter_path (project_id, "global", parameter_id)
 # Delete the parameter.
 client.delete_parameter (name=name)
 # Print confirmation of deletion.
 print(f"Deleted parameter: {name}")

Ruby

To run this code, first set up a Ruby development environment and install the Parameter Manager Ruby SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

require"google/cloud/parameter_manager"
##
# Delete a parameter
#
# @param project_id [String] The Google Cloud project (e.g. "my-project")
# @param parameter_id [String] The parameter name (e.g. "my-parameter")
#
defdelete_paramproject_id:,parameter_id:
# Create a Parameter Manager client.
client=Google::Cloud::ParameterManager .parameter_manager
# Build the resource name of the parent project.
name=client.parameter_path project:project_id,location:"global",parameter:parameter_id
# Create the parameter version.
param_version=client.delete_parametername:name
# Print the parameter version name.
puts"Deleted parameter #{name}"
end

Regional parameters

Console

  1. In the Google Cloud console, go to the Secret Manager page.

    Go to Secret Manager

  2. Click Parameter Manager to go to the Parameter Manager page. You'll see the list of parameters for that project.

  3. Click the Actions menu associated with the parameter that you want to delete, and then click Delete.

  4. In the confirmation dialog that appears, enter the name of the parameter, and click Delete. Note that you can't delete multiple parameters at a time. You also can't delete parameters that have versions.

gcloud

Before using any of the command data below, make the following replacements:

  • PARAMETER_ID: the name of the parameter
  • LOCATION: the Google Cloud location of the parameter

Execute the following command:

Linux, macOS, or Cloud Shell

gcloudparametermanagerparametersdeletePARAMETER_ID--location=LOCATION

Windows (PowerShell)

gcloudparametermanagerparametersdeletePARAMETER_ID--location=LOCATION

Windows (cmd.exe)

gcloudparametermanagerparametersdeletePARAMETER_ID--location=LOCATION

You should receive a response similar to the following:

You are about to delete parameter [app_config]
Do you want to continue (Y/n)? y
Deleted parameter [app_config].

REST

Before using any of the request data, make the following replacements:

  • LOCATION: the Google Cloud location of the parameter
  • PROJECT_ID: the Google Cloud project ID
  • PARAMETER_ID: the name of the parameter

HTTP method and URL:

DELETE https://parametermanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/parameters/PARAMETER_ID

Request JSON body:

{}

To send your request, choose one of these options:

curl

Save the request body in a file named request.json, and execute the following command:

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://parametermanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/parameters/PARAMETER_ID"

PowerShell

Save the request body in a file named request.json, and execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://parametermanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/parameters/PARAMETER_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{}

C#

To run this code, first set up a C# development environment and install the Parameter Manager C# SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.


usingGoogle.Cloud.ParameterManager.V1 ;
publicclassDeleteRegionalParameterSample
{
/// <summary>
/// This function deletes a regional parameter using the Parameter Manager SDK for GCP.
/// </summary>
/// <param name="projectId">The ID of the project where the parameter is located.</param>
/// <param name="locationId">The ID of the region where the parameter is located.</param>
/// <param name="parameterId">The ID of the parameter to be deleted.</param>
publicvoidDeleteRegionalParameter(
stringprojectId,
stringlocationId,
stringparameterId)
{
// Define the regional endpoint
stringregionalEndpoint=$"parametermanager.{locationId}.rep.googleapis.com";
// Create the client with the regional endpoint
ParameterManagerClient client=newParameterManagerClientBuilder
{
Endpoint=regionalEndpoint
}.Build ();
// Build the resource name for the parameter in the specified regional locationId
ParameterName parameterName=newParameterName (projectId,locationId,parameterId);
// Call the API to delete the parameter
client.DeleteParameter (parameterName);
Console.WriteLine($"Deleted regional parameter: {parameterName}");
}
}

Go

To run this code, first set up a Go development environment and install the Parameter Manager Go SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

import(
"context"
"fmt"
"io"
parametermanager"cloud.google.com/go/parametermanager/apiv1"
parametermanagerpb"cloud.google.com/go/parametermanager/apiv1/parametermanagerpb"
"google.golang.org/api/option"
)
// deleteRegionalParam deletes a regional parameter using the Parameter Manager SDK for GCP.
//
// w: The io.Writer object used to write the output.
// projectID: The ID of the project where the parameter is located.
// locationID: The ID of the region where the parameter is located.
// parameterID: The ID of the parameter to be deleted.
//
// The function returns an error if the parameter deletion fails.
funcdeleteRegionalParam(wio.Writer,projectID,locationID,parameterIDstring)error{
// Create a new context.
ctx:=context.Background()
// Create a Parameter Manager client.
endpoint:=fmt.Sprintf("parametermanager.%s.rep.googleapis.com:443",locationID)
client,err:=parametermanager.NewClient (ctx,option.WithEndpoint(endpoint))
iferr!=nil{
returnfmt.Errorf("failed to create Parameter Manager client: %w",err)
}
deferclient.Close ()
// Construct the name of the parameter to delete.
name:=fmt.Sprintf("projects/%s/locations/%s/parameters/%s",projectID,locationID,parameterID)
// Build the request to delete the parameter.
req:=&parametermanagerpb.DeleteParameterRequest{
Name:name,
}
// Call the API to delete the parameter.
iferr:=client.DeleteParameter(ctx,req);err!=nil{
returnfmt.Errorf("failed to delete parameter: %w",err)
}
fmt.Fprintf(w,"Deleted regional parameter: %s\n",name)
returnnil
}

Java

To run this code, first set up a Java development environment and install the Parameter Manager Java SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.


importcom.google.cloud.parametermanager.v1.ParameterManagerClient ;
importcom.google.cloud.parametermanager.v1.ParameterManagerSettings ;
importcom.google.cloud.parametermanager.v1.ParameterName ;
importjava.io.IOException;
/**
 * This class demonstrates how to delete a regional parameter using the Parameter Manager SDK for
 * GCP.
 */
publicclass DeleteRegionalParam{
publicstaticvoidmain(String[]args)throwsIOException{
// TODO(developer): Replace these variables before running the sample.
StringprojectId="your-project-id";
StringlocationId="your-location-id";
StringparameterId="your-parameter-id";
// Call the method to delete a regional parameter.
deleteRegionalParam(projectId,locationId,parameterId);
}
// This is an example snippet that deletes a regional parameter.
publicstaticvoiddeleteRegionalParam(StringprojectId,StringlocationId,StringparameterId)
throwsIOException{
// Endpoint to call the regional parameter manager server
StringapiEndpoint=String.format("parametermanager.%s.rep.googleapis.com:443",locationId);
ParameterManagerSettings parameterManagerSettings=
ParameterManagerSettings .newBuilder().setEndpoint(apiEndpoint).build();
// Initialize the client that will be used to send requests. This client only
// needs to be created once, and can be reused for multiple requests.
try(ParameterManagerClient client=ParameterManagerClient .create(parameterManagerSettings)){
// Build the parameter name.
ParameterName parameterName=ParameterName .of(projectId,locationId,parameterId);
// Delete the parameter.
client.deleteParameter(parameterName.toString ());
System.out.printf("Deleted regional parameter: %s\n",parameterName.toString ());
}
}
}

Node.js

To run this code, first set up a Node.js development environment and install the Parameter Manager Node.js SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'my-project';
// const locationId = 'us-central1';
// const parameterId = 'my-parameter';
// Imports the Parameter Manager library
const{ParameterManagerClient}=require('@google-cloud/parametermanager');
// Adding the endpoint to call the regional parameter manager server
constoptions={
apiEndpoint:`parametermanager.${locationId}.rep.googleapis.com`,
};
// Instantiates a client with regional endpoint
constclient=newParameterManagerClient (options);
asyncfunctiondeleteRegionalParam(){
// Construct the fully qualified parameter name
constname=client.parameterPath (projectId,locationId,parameterId);
// Delete the parameter
awaitclient.deleteParameter({
name:name,
});
console.log(`Deleted regional parameter: ${name}`);
returnname;
}
returnawaitdeleteRegionalParam();

PHP

To run this code, first learn about using PHP on Google Cloud and install the Parameter Manager PHP SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

// Import necessary classes for delete a parameter.
use Google\Cloud\ParameterManager\V1\Client\ParameterManagerClient;
use Google\Cloud\ParameterManager\V1\DeleteParameterRequest;
/**
 * Deletes a regional parameter using the Parameter Manager SDK for GCP.
 *
 * @param string $projectId The Google Cloud Project ID (e.g. 'my-project')
 * @param string $locationId The Parameter Location (e.g. 'us-central1')
 * @param string $parameterId The Parameter ID (e.g. 'my-param')
 */
function delete_regional_param(string $projectId, string $locationId, string $parameterId): void
{
 // Specify regional endpoint.
 $options = ['apiEndpoint' => "parametermanager.$locationId.rep.googleapis.com"];
 // Create a client for the Parameter Manager service.
 $client = new ParameterManagerClient($options);
 // Build the resource name of the paramete.
 $parameterName = $client->parameterName($projectId, $locationId, $parameterId);
 // Prepare the request to delete the parameter.
 $request = (new DeleteParameterRequest())
 ->setName($parameterName);
 // Delete the parameter using the client.
 $client->deleteParameter($request);
 printf('Deleted regional parameter: %s' . PHP_EOL, $parameterId);
}

Python

To run this code, first set up a Python development environment and install the Parameter Manager Python SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

defdelete_regional_param(project_id: str, location_id: str, parameter_id: str) -> None:
"""
 Deletes a parameter from the specified region of the specified
 project using the Google Cloud Parameter Manager SDK.
 Args:
 project_id (str): The ID of the project
 where the parameter is located.
 location_id (str): The ID of the region
 where the parameter is located.
 parameter_id (str): The ID of the parameter to delete.
 Returns:
 None
 Example:
 delete_regional_param(
 "my-project",
 "us-central1",
 "my-regional-parameter"
 )
 """
 # Import the necessary library for Google Cloud Parameter Manager.
 fromgoogle.cloudimport parametermanager_v1
 # Create the Parameter Manager client with the regional endpoint.
 api_endpoint = f"parametermanager.{location_id}.rep.googleapis.com"
 client = parametermanager_v1 .ParameterManagerClient (
 client_options={"api_endpoint": api_endpoint}
 )
 # Build the resource name of the parameter.
 name = client.parameter_path (project_id, location_id, parameter_id)
 # Delete the parameter.
 client.delete_parameter (name=name)
 # Print confirmation of deletion.
 print(f"Deleted regional parameter: {name}")

Ruby

To run this code, first set up a Ruby development environment and install the Parameter Manager Ruby SDK. On Compute Engine or GKE, you must authenticate with the cloud-platform scope.

require"google/cloud/parameter_manager"
##
# Delete a parameter
#
# @param project_id [String] The Google Cloud project (e.g. "my-project")
# @param location_id [String] The location name (e.g. "us-central1")
# @param parameter_id [String] The parameter name (e.g. "my-parameter")
#
defdelete_regional_paramproject_id:,location_id:,parameter_id:
# Endpoint for the regional parameter manager service.
api_endpoint="parametermanager.#{location_id}.rep.googleapis.com"
# Create the Parameter Manager client.
client=Google::Cloud::ParameterManager .parameter_manager do|config|
config.endpoint=api_endpoint
end
# Build the resource name of the parent project.
name=client.parameter_path project:project_id,location:location_id,parameter:parameter_id
# Create the parameter version.
param_version=client.delete_parametername:name
# Print the parameter version name.
puts"Deleted regional parameter #{name}"
end

What's next

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026年08月26日 UTC.