You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/apigee_v1.organizations.environments.html
+42Lines changed: 42 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -259,6 +259,12 @@ <h3>Method Details</h3>
259
259
260
260
{
261
261
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
262
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
263
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
264
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
265
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
266
+
},
267
+
},
262
268
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
263
269
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
264
270
"description": "A String", # Optional. Description of the environment.
@@ -365,6 +371,12 @@ <h3>Method Details</h3>
365
371
366
372
{
367
373
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
374
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
375
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
376
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
377
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
378
+
},
379
+
},
368
380
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
369
381
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
370
382
"description": "A String", # Optional. Description of the environment.
@@ -800,6 +812,12 @@ <h3>Method Details</h3>
800
812
801
813
{
802
814
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
815
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
816
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
817
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
818
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
819
+
},
820
+
},
803
821
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
804
822
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
805
823
"description": "A String", # Optional. Description of the environment.
@@ -1025,6 +1043,12 @@ <h3>Method Details</h3>
1025
1043
1026
1044
{
1027
1045
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
1046
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
1047
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
1048
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
1049
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
1050
+
},
1051
+
},
1028
1052
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
1029
1053
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
1030
1054
"description": "A String", # Optional. Description of the environment.
@@ -1060,6 +1084,12 @@ <h3>Method Details</h3>
1060
1084
1061
1085
{
1062
1086
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
1087
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
1088
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
1089
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
1090
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
1091
+
},
1092
+
},
1063
1093
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
1064
1094
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
1065
1095
"description": "A String", # Optional. Description of the environment.
@@ -1173,6 +1203,12 @@ <h3>Method Details</h3>
1173
1203
1174
1204
{
1175
1205
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
1206
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
1207
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
1208
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
1209
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
1210
+
},
1211
+
},
1176
1212
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
1177
1213
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
1178
1214
"description": "A String", # Optional. Description of the environment.
@@ -1208,6 +1244,12 @@ <h3>Method Details</h3>
1208
1244
1209
1245
{
1210
1246
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
1247
+
"clientIpResolutionConfig": { # Configuration for resolving the client ip. # Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution.
1248
+
"headerIndexAlgorithm": { # Resolves the client ip based on a custom header. # Resolves the client ip based on a custom header.
1249
+
"ipHeaderIndex": 42, # Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
1250
+
"ipHeaderName": "A String", # Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.
1251
+
},
1252
+
},
1211
1253
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
1212
1254
"deploymentType": "A String", # Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
1213
1255
"description": "A String", # Optional. Description of the environment.
"description": "Optional. The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ \"clientIpResolutionConfig\" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution."
13396
+
},
13393
13397
"createdAt": {
13394
13398
"description": "Output only. Creation time of this environment as milliseconds since epoch.",
"description": "Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)",
13505
+
"format": "int32",
13506
+
"type": "integer"
13507
+
},
13508
+
"ipHeaderName": {
13509
+
"description": "Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.",
0 commit comments