Method: projects.locations.servers.stop

Stops an active Server.

HTTP request

POST https://ftp.googleapis.com/v1/{name=projects/*/locations/*/servers/*}:stop

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • ftp.servers.update

For more information, see the IAM documentation.