1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.targetservers.html">targetservers</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a TargetServer in the specified environment.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a TargetServer resource.</p> 89<p class="toc_element"> 90 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">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.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code> 100 <pre>Creates a TargetServer in the specified environment. 101 102Args: 103 parent: string, Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`. (required) 104 body: object, The request body. 105 The object takes the form of: 106 107{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. 108 "description": "A String", # Optional. A human-readable description of this TargetServer. 109 "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. 110 "isEnabled": True or False, # 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. 111 "name": "A String", # Required. The resource id of this target server. Values must match the regular expression 112 "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. 113 "protocol": "A String", # Immutable. The protocol used by this TargetServer. 114 "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. 115 "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites 116 "A String", 117 ], 118 "clientAuthEnabled": True or False, # Optional. Enables two-way TLS. 119 "commonName": { # The TLS Common Name of the certificate. 120 "value": "A String", # The TLS Common Name string of the certificate. 121 "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert. 122 }, 123 "enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. 124 "ignoreValidationErrors": True or False, # 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. 125 "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. 126 "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported. 127 "protocols": [ # The TLS versioins to be used. 128 "A String", 129 ], 130 "trustStore": "A String", # The resource ID of the truststore. References not yet supported. 131 }, 132} 133 134 name: string, Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer. 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139 140Returns: 141 An object of the form: 142 143 { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. 144 "description": "A String", # Optional. A human-readable description of this TargetServer. 145 "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. 146 "isEnabled": True or False, # 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. 147 "name": "A String", # Required. The resource id of this target server. Values must match the regular expression 148 "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. 149 "protocol": "A String", # Immutable. The protocol used by this TargetServer. 150 "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. 151 "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites 152 "A String", 153 ], 154 "clientAuthEnabled": True or False, # Optional. Enables two-way TLS. 155 "commonName": { # The TLS Common Name of the certificate. 156 "value": "A String", # The TLS Common Name string of the certificate. 157 "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert. 158 }, 159 "enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. 160 "ignoreValidationErrors": True or False, # 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. 161 "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. 162 "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported. 163 "protocols": [ # The TLS versioins to be used. 164 "A String", 165 ], 166 "trustStore": "A String", # The resource ID of the truststore. References not yet supported. 167 }, 168}</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 173 <pre>Deletes a TargetServer from an environment. Returns the deleted TargetServer resource. 174 175Args: 176 name: string, Required. The name of the TargetServer to delete. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required) 177 x__xgafv: string, V1 error format. 178 Allowed values 179 1 - v1 error format 180 2 - v2 error format 181 182Returns: 183 An object of the form: 184 185 { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. 186 "description": "A String", # Optional. A human-readable description of this TargetServer. 187 "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. 188 "isEnabled": True or False, # 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. 189 "name": "A String", # Required. The resource id of this target server. Values must match the regular expression 190 "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. 191 "protocol": "A String", # Immutable. The protocol used by this TargetServer. 192 "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. 193 "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites 194 "A String", 195 ], 196 "clientAuthEnabled": True or False, # Optional. Enables two-way TLS. 197 "commonName": { # The TLS Common Name of the certificate. 198 "value": "A String", # The TLS Common Name string of the certificate. 199 "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert. 200 }, 201 "enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. 202 "ignoreValidationErrors": True or False, # 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. 203 "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. 204 "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported. 205 "protocols": [ # The TLS versioins to be used. 206 "A String", 207 ], 208 "trustStore": "A String", # The resource ID of the truststore. References not yet supported. 209 }, 210}</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="get">get(name, x__xgafv=None)</code> 215 <pre>Gets a TargetServer resource. 216 217Args: 218 name: string, Required. The name of the TargetServer to get. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required) 219 x__xgafv: string, V1 error format. 220 Allowed values 221 1 - v1 error format 222 2 - v2 error format 223 224Returns: 225 An object of the form: 226 227 { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. 228 "description": "A String", # Optional. A human-readable description of this TargetServer. 229 "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. 230 "isEnabled": True or False, # 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. 231 "name": "A String", # Required. The resource id of this target server. Values must match the regular expression 232 "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. 233 "protocol": "A String", # Immutable. The protocol used by this TargetServer. 234 "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. 235 "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites 236 "A String", 237 ], 238 "clientAuthEnabled": True or False, # Optional. Enables two-way TLS. 239 "commonName": { # The TLS Common Name of the certificate. 240 "value": "A String", # The TLS Common Name string of the certificate. 241 "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert. 242 }, 243 "enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. 244 "ignoreValidationErrors": True or False, # 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. 245 "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. 246 "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported. 247 "protocols": [ # The TLS versioins to be used. 248 "A String", 249 ], 250 "trustStore": "A String", # The resource ID of the truststore. References not yet supported. 251 }, 252}</pre> 253</div> 254 255<div class="method"> 256 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 257 <pre>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. 258 259Args: 260 name: string, Required. The name of the TargetServer to replace. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required) 261 body: object, The request body. 262 The object takes the form of: 263 264{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. 265 "description": "A String", # Optional. A human-readable description of this TargetServer. 266 "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. 267 "isEnabled": True or False, # 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. 268 "name": "A String", # Required. The resource id of this target server. Values must match the regular expression 269 "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. 270 "protocol": "A String", # Immutable. The protocol used by this TargetServer. 271 "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. 272 "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites 273 "A String", 274 ], 275 "clientAuthEnabled": True or False, # Optional. Enables two-way TLS. 276 "commonName": { # The TLS Common Name of the certificate. 277 "value": "A String", # The TLS Common Name string of the certificate. 278 "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert. 279 }, 280 "enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. 281 "ignoreValidationErrors": True or False, # 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. 282 "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. 283 "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported. 284 "protocols": [ # The TLS versioins to be used. 285 "A String", 286 ], 287 "trustStore": "A String", # The resource ID of the truststore. References not yet supported. 288 }, 289} 290 291 x__xgafv: string, V1 error format. 292 Allowed values 293 1 - v1 error format 294 2 - v2 error format 295 296Returns: 297 An object of the form: 298 299 { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. 300 "description": "A String", # Optional. A human-readable description of this TargetServer. 301 "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. 302 "isEnabled": True or False, # 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. 303 "name": "A String", # Required. The resource id of this target server. Values must match the regular expression 304 "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. 305 "protocol": "A String", # Immutable. The protocol used by this TargetServer. 306 "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. 307 "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites 308 "A String", 309 ], 310 "clientAuthEnabled": True or False, # Optional. Enables two-way TLS. 311 "commonName": { # The TLS Common Name of the certificate. 312 "value": "A String", # The TLS Common Name string of the certificate. 313 "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert. 314 }, 315 "enabled": True or False, # Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. 316 "ignoreValidationErrors": True or False, # 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. 317 "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. 318 "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported. 319 "protocols": [ # The TLS versioins to be used. 320 "A String", 321 ], 322 "trustStore": "A String", # The resource ID of the truststore. References not yet supported. 323 }, 324}</pre> 325</div> 326 327</body></html>