Send Docs Feedback

Making management API calls from this page

  1. In the URL, replace any values indicated by "{ }", such as your organization name.
  2. Set the Basic Authentication credentials: Edge email and password (user must be in the Org Admin role).
    Create an Apigee account if you don't have one.
  3. Tweak the parameters and request body as needed.
  4. Send the live request to Edge!

Update a TargetServer

Resource Summary


Content Type

application/json, text/xml





Update a TargetServer

Modifies an existing TargetServer.

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.

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. false No
enabled Enables one-way SSL. You must have defined a keystore containing the cert and private key. false No
clientAuthEnabled Enables two-way, or client, SSL between Edge (server) and the app (client) making the request. 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 SSL. N/A No
ignoreValidationErrors If true, specifies to ignore SSL 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 virtual host. 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?