You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to

Update a TargetServer

Resource Summary


Content Type

application/json, text/xml





Update a TargetServer

Modifies an existing TargetServer. (You can also modify TargetServers in the management UI, as described in Load balancing across backend servers.)

For example, use this method to toggles a TargetServer configuration from enabled to disabled. This is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. You could also use this API to modify the hostname of an enabled target server.

Note: In the request body when Content-Type is set to application/json, use the element sSLInfo in the request body, not SSLInfo (note the case). You must use the case sSLInfo exactly. Using SSLInfo will cause an error when Content-Type is set to application/json. The case does not matter if Content-Type is application/xml. 

Resource URL /organizations/{org_name}/environments/{env_name}/targetservers/{targetserver_name}

Header Parameters

Name Values Description

Specify the content type as application/json or text/xml.

Request Body

Name Description Default Required?
Name The name of the target server. You can choose anything you like. N/A Yes
Host The DNS name or IP address of the machine that this TargetServer will refer to. N/A Yes
Port The port on which the backend service is configured to listen. If you don't specify a port, it defaults to zero, which is invalid. If you're not sure, try port 80. 0 Yes
IsEnabled A boolean (true/false) that determines whether this TargetServer is enabled or not. You can use this setting to take TargetServers out of rotation, without requiring you to delete the TargetServer definition. true No
enabled Enables one-way TLS. You must have defined a keystore containing the cert and private key. false No
clientAuthEnabled Enables two-way, or client, TLS between Edge (as a client making the request) and the target (as a server). false No
keyStore The name of the keystore on Edge. N/A No
keyAlias The alias specified when you uploaded the JAR file containing the cert and private key to the keystore. N/A No
trustStore The name of the truststore on Edge that contains the certificate or certificate chain used for two-way TLS. N/A No
ignoreValidationErrors If true, specifies to ignore TLS certificate errors. This is similar to the "-k" option to cURL. false No
ciphers Specifies the ciphers supported by the virtual host. If no ciphers are specified, then all ciphers available for the JVM will be permitted. All supported by the JVM No
protocols Specifies the protocols supported by the target server. For example, SSLv3, TLSv1, TLSv1.1, TLSv1.2.

If no protocols are specified, then all protocols available for the JVM will be permitted.
All supported by the JVM No

org_name Mention the organization name true

env_name Mention the environment name true

targetserver_name Mention the TargetServer name true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)