Delete an SFTP server

This document shows how to delete an SFTP server.

Before you begin

• Remove all users from the server. For steps, see Delete users from an SFTP server.

Required roles

To get the permission that you need to delete an SFTP server, ask your administrator to grant you the Cloud FTP Admin (roles/ftp.admin) IAM role on your project. For more information about granting roles, see Manage access to projects, folders, and organizations.

This predefined role contains the ftp.servers.delete permission, which is required to delete an SFTP server.

You might also be able to get this permission with custom roles or other predefined roles.

Delete a server

gcloud

To delete an SFTP server, run the gcloud alpha storage ftp servers delete command.

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

• SERVER_ID: the SFTP server ID.
• LOCATION_ID: the location of the server, such as us-west1.

Execute the following command:

Linux, macOS, or Cloud Shell

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

gcloud alpha storage ftp servers delete SERVER_ID --location=LOCATION_ID

Windows (PowerShell)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

gcloud alpha storage ftp servers delete SERVER_ID --location=LOCATION_ID

Windows (cmd.exe)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

gcloud alpha storage ftp servers delete SERVER_ID --location=LOCATION_ID

It takes about 10 minutes for the server to be deleted.

REST

To delete an SFTP server, use the servers.delete method.

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

• PROJECT_ID: the Google Cloud project ID.
• LOCATION_ID: the location of the server, such as us-west1.
• SERVER_ID: the SFTP server ID.

HTTP method and URL:

DELETE https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID"

PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

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

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID" | Select-Object -Expand Content

The response identifies a long-running operation. It takes about 10 minutes for the server to be deleted.