Send Docs Feedback

SmartDocs basics

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge email and password (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Update a TargetServer

Resource Summary

Auth Type


Content Type

application/json, text/xml


Target Server,



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
  • Content-Type
    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

org_name Mention the organization name true

env_name Mention the environment name true

targetserver_name Mention the TargetServer name true

Basic Auth

OAuth 2

Custom Token


Make a request and see the response.

Make a request and see the response.


Help or comments?