1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.apiproducts.html">apiproducts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.apiproducts.attributes.html">attributes()</a></code>
</p>
<p class="firstline">Returns the attributes Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.apiproducts.rateplans.html">rateplans()</a></code>
</p>
<p class="firstline">Returns the rateplans Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. **WARNING:** - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, attributename=None, attributevalue=None, count=None, expand=None, space=None, startKey=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).</p>
<p class="toc_element">
<code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves an API product to a different space.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. **WARNING:** - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?
Args:
parent: string, Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
body: object, The request body.
The object takes the form of:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
Args:
name: string, Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
Args:
name: string, Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, attributename=None, attributevalue=None, count=None, expand=None, space=None, startKey=None, x__xgafv=None)</code>
<pre>Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
Args:
parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
attributename: string, Name of the attribute used to filter the search.
attributevalue: string, Value of the attribute used to filter the search.
count: string, Enter the number of API products you want returned in the API call. The limit is 1000.
expand: boolean, Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API.
space: string, Optional. The Space to list API products for. When none provided, all the spaces the user has list access, will be used implicitly, and the same following rules will apply. Can be used in conjunction with start_key, expand and count for paginated response. Composite queries with attributename and attributevalue are not supported yet.
startKey: string, Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiProduct": [ # Lists all API product names defined for an organization.
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
<pre>Moves an API product to a different space.
Args:
name: string, Required. API product to move in the following format: `organizations/{org}/apiproducts/{apiproduct} (required)
body: object, The request body.
The object takes the form of:
{ # Moves API product to a different space.
"space": "A String", # Optional. Resource ID of the space to move the API product to. If unspecified, the API product will be moved to the organization level.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.
Args:
name: string, Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
body: object, The request body.
The object takes the form of:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
"A String",
],
"approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
"attributes": [ # Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch.
"description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields.
"displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access.
"environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
"A String",
],
"graphqlOperationGroup": { # List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
"operationConfigType": "A String", # Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.
{ # Represents the pairing of GraphQL operation types and the GraphQL operation name.
"operation": "A String", # GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.
"operationTypes": [ # Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.
"A String",
],
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"grpcOperationGroup": { # List of gRPC operation configuration details associated with Apigee API proxies. # Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies that are associated with this API product.
{ # Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy with which the gRPC operation and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"methods": [ # List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"].
"A String",
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the methods and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
"service": "A String", # Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon.
},
],
},
"lastModifiedAt": "A String", # Response only. Modified time of this environment as milliseconds since epoch.
"name": "A String", # Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.
"operationGroup": { # List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. # Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail.
"operationConfigType": "A String", # Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
"operationConfigs": [ # Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.
{ # Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
"apiSource": "A String", # Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
"attributes": [ # Custom attributes associated with the operation.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"operations": [ # List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.
{ # Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
"methods": [ # methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.
"A String",
],
"resource": "A String", # Required. REST resource path associated with the API proxy or remote service.
},
],
"quota": { # Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. # Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.
"interval": "A String", # Required. Time interval over which the number of request messages is calculated.
"limit": "A String", # Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.
"timeUnit": "A String", # Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.
},
},
],
},
"proxies": [ # Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.
"A String",
],
"quota": "A String", # Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
"quotaCounterScope": "A String", # Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
"quotaInterval": "A String", # Time interval over which the number of request messages is calculated.
"quotaTimeUnit": "A String", # Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
"scopes": [ # Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
"A String",
],
"space": "A String", # Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
</body></html>
|
