/
apigee-api.json
15359 lines (15359 loc) · 729 KB
/
apigee-api.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://apigee.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Apigee",
"description": "Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/apigee-api-management/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "apigee:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://apigee.mtls.googleapis.com/",
"name": "apigee",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"hybrid": {
"resources": {
"issuers": {
"methods": {
"list": {
"description": "Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn-authz service to query control plane's issuer service account ids.",
"flatPath": "v1/hybrid/issuers",
"httpMethod": "GET",
"id": "apigee.hybrid.issuers.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Must be of the form `hybrid/issuers`.",
"location": "path",
"pattern": "^hybrid/issuers$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ListHybridIssuersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"methods": {
"create": {
"description": "Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).",
"flatPath": "v1/organizations",
"httpMethod": "POST",
"id": "apigee.organizations.create",
"parameterOrder": [],
"parameters": {
"parent": {
"description": "Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`",
"location": "query",
"type": "string"
}
},
"path": "v1/organizations",
"request": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations, a soft-deletion is performed. The organization can be restored within the soft-deletion period which can be controlled using the retention field in the request.",
"flatPath": "v1/organizations/{organizationsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"retention": {
"description": "Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored.",
"enum": [
"DELETION_RETENTION_UNSPECIFIED",
"MINIMUM"
],
"enumDescriptions": [
"Default data retention setting of seven days will be applied.",
"Organization data will be retained for the minimum period of 24 hours."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).",
"flatPath": "v1/organizations/{organizationsId}",
"httpMethod": "GET",
"id": "apigee.organizations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Apigee organization name in the following format: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getDeployedIngressConfig": {
"description": "Gets the deployed ingress configuration for an organization.",
"flatPath": "v1/organizations/{organizationsId}/deployedIngressConfig",
"httpMethod": "GET",
"id": "apigee.organizations.getDeployedIngressConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'.",
"location": "path",
"pattern": "^organizations/[^/]+/deployedIngressConfig$",
"required": true,
"type": "string"
},
"view": {
"description": "When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules.",
"enum": [
"INGRESS_CONFIG_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default/unset value. The API will default to the BASIC view.",
"Include all ingress config data necessary for the runtime to configure ingress, but no more. Routing rules will include only basepath and destination environment. This the default value.",
"Include all ingress config data, including internal debug info for each routing rule such as the proxy claiming a particular basepath and when the routing rule first appeared in the env group."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1IngressConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getProjectMapping": {
"description": "Gets the project ID and region for an Apigee organization.",
"flatPath": "v1/organizations/{organizationsId}:getProjectMapping",
"httpMethod": "GET",
"id": "apigee.organizations.getProjectMapping",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Apigee organization name in the following format: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:getProjectMapping",
"response": {
"$ref": "GoogleCloudApigeeV1OrganizationProjectMapping"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getRuntimeConfig": {
"description": "Get runtime config for an organization.",
"flatPath": "v1/organizations/{organizationsId}/runtimeConfig",
"httpMethod": "GET",
"id": "apigee.organizations.getRuntimeConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the runtime config for the organization in the following format: 'organizations/{org}/runtimeConfig'.",
"location": "path",
"pattern": "^organizations/[^/]+/runtimeConfig$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1RuntimeConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getSyncAuthorization": {
"description": "Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.",
"flatPath": "v1/organizations/{organizationsId}:getSyncAuthorization",
"httpMethod": "POST",
"id": "apigee.organizations.getSyncAuthorization",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:getSyncAuthorization",
"request": {
"$ref": "GoogleCloudApigeeV1GetSyncAuthorizationRequest"
},
"response": {
"$ref": "GoogleCloudApigeeV1SyncAuthorization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).",
"flatPath": "v1/organizations",
"httpMethod": "GET",
"id": "apigee.organizations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Use the following structure in your request: `organizations`",
"location": "path",
"pattern": "^organizations$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}",
"response": {
"$ref": "GoogleCloudApigeeV1ListOrganizationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setAddons": {
"description": "Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.",
"flatPath": "v1/organizations/{organizationsId}:setAddons",
"httpMethod": "POST",
"id": "apigee.organizations.setAddons",
"parameterOrder": [
"org"
],
"parameters": {
"org": {
"description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+org}:setAddons",
"request": {
"$ref": "GoogleCloudApigeeV1SetAddonsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setSyncAuthorization": {
"description": "Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.",
"flatPath": "v1/organizations/{organizationsId}:setSyncAuthorization",
"httpMethod": "POST",
"id": "apigee.organizations.setSyncAuthorization",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setSyncAuthorization",
"request": {
"$ref": "GoogleCloudApigeeV1SyncAuthorization"
},
"response": {
"$ref": "GoogleCloudApigeeV1SyncAuthorization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.",
"flatPath": "v1/organizations/{organizationsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Apigee organization name in the following format: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"response": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"analytics": {
"resources": {
"datastores": {
"methods": {
"create": {
"description": "Create a Datastore for an org",
"flatPath": "v1/organizations/{organizationsId}/analytics/datastores",
"httpMethod": "POST",
"id": "apigee.organizations.analytics.datastores.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization name. Must be of the form `organizations/{org}`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/analytics/datastores",
"request": {
"$ref": "GoogleCloudApigeeV1Datastore"
},
"response": {
"$ref": "GoogleCloudApigeeV1Datastore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a Datastore from an org.",
"flatPath": "v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.analytics.datastores.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Datastore to be deleted. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`",
"location": "path",
"pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get a Datastore",
"flatPath": "v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}",
"httpMethod": "GET",
"id": "apigee.organizations.analytics.datastores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Datastore to be get. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`",
"location": "path",
"pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Datastore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List Datastores",
"flatPath": "v1/organizations/{organizationsId}/analytics/datastores",
"httpMethod": "GET",
"id": "apigee.organizations.analytics.datastores.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization name. Must be of the form `organizations/{org}`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"targetType": {
"description": "Optional. TargetType is used to fetch all Datastores that match the type",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/analytics/datastores",
"response": {
"$ref": "GoogleCloudApigeeV1ListDatastoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"test": {
"description": "Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage",
"flatPath": "v1/organizations/{organizationsId}/analytics/datastores:test",
"httpMethod": "POST",
"id": "apigee.organizations.analytics.datastores.test",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization name Must be of the form `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/analytics/datastores:test",
"request": {
"$ref": "GoogleCloudApigeeV1Datastore"
},
"response": {
"$ref": "GoogleCloudApigeeV1TestDatastoreResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Update a Datastore",
"flatPath": "v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}",
"httpMethod": "PUT",
"id": "apigee.organizations.analytics.datastores.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of datastore to be updated. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`",
"location": "path",
"pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Datastore"
},
"response": {
"$ref": "GoogleCloudApigeeV1Datastore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"apiproducts": {
"methods": {
"attributes": {
"description": "Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.attributes",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/attributes",
"request": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "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?",
"flatPath": "v1/organizations/{organizationsId}/apiproducts",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/apiproducts",
"request": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "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.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apiproducts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "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.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "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.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"attributename": {
"description": "Name of the attribute used to filter the search.",
"location": "query",
"type": "string"
},
"attributevalue": {
"description": "Value of the attribute used to filter the search.",
"location": "query",
"type": "string"
},
"count": {
"description": "Enter the number of API products you want returned in the API call. The limit is 1000.",
"format": "int64",
"location": "query",
"type": "string"
},
"expand": {
"description": "Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"startKey": {
"description": "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.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/apiproducts",
"response": {
"$ref": "GoogleCloudApigeeV1ListApiProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "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.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.apiproducts.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"attributes": {
"methods": {
"delete": {
"description": "Deletes an API product attribute.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apiproducts.attributes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the value of an API product attribute.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.attributes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all API product attributes.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.attributes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attributes",
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateApiProductAttribute": {
"description": "Updates the value of an API product attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.attributes.updateApiProductAttribute",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"rateplans": {
"methods": {
"create": {
"description": "Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but *only one* rate plan can be active at any point of time. **Note: From the developer's perspective, they purchase API products not rate plans.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.rateplans.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/rateplans",
"request": {
"$ref": "GoogleCloudApigeeV1RatePlan"
},
"response": {
"$ref": "GoogleCloudApigeeV1RatePlan"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a rate plan.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apiproducts.rateplans.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/rateplans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1RatePlan"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the details of a rate plan.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.rateplans.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/rateplans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {