Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.


You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apigee1 --scope <scope> organizations environments-targetservers-update ...

Required Scalar Argument

  • <name> (string)
    • Required. The name of the TargetServer to replace. Must be of the form organizations/{org}/environments/{env}/targetservers/{target_server_id}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

  description: string
  host: string
  is-enabled: boolean
  name: string
  port: integer
  protocol: string
    ciphers: [string]
    client-auth-enabled: boolean
      value: string
      wildcard-match: boolean
    enabled: boolean
    ignore-validation-errors: boolean
    key-alias: string
    key-store: string
    protocols: [string]
    trust-store: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . description=stet
    • Optional. A human-readable description of this TargetServer.
  • host=sea
    • Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
  • is-enabled=true
    • Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
  • name=consetetur
    • Required. The resource id of this target server. Values must match the regular expression
  • port=32
    • Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
  • protocol=sit
    • Immutable. The protocol used by this TargetServer.
  • s-sl-info ciphers=sea
    • The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    • Each invocation of this argument appends the given value to the array.
  • client-auth-enabled=true
    • Optional. Enables two-way TLS.
  • common-name value=kasd
    • The TLS Common Name string of the certificate.
  • wildcard-match=false

    • Indicates whether the cert should be matched against as a wildcard cert.
  • .. enabled=true

    • Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
  • ignore-validation-errors=true
    • If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
  • key-alias=amet
    • Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
  • key-store=sea
    • Required if client_auth_enabled is true. The resource ID of the keystore.
  • protocols=sadipscing
    • The TLS versioins to be used.
    • Each invocation of this argument appends the given value to the array.
  • trust-store=dolore
    • The resource ID of the truststore.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").