-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yaml
4366 lines (4362 loc) · 135 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
title: Portal API
version: 2.1.0
description: Portal API
contact:
name: Kong
url: 'https://cloud.konghq.com'
servers:
- url: 'https://custom.example.com'
description: Production
paths:
/api/v2/applications:
get:
operationId: list-applications
summary: List Applications
description: List applications owned by the developer currently logged in.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/FilterByNameEquality'
- $ref: '#/components/parameters/FilterByNameEqualityShort'
- $ref: '#/components/parameters/FilterByNameContains'
- $ref: '#/components/parameters/FilterByAuthStrategyEquality'
- $ref: '#/components/parameters/FilterByAuthStrategyEqualityShort'
responses:
'200':
$ref: '#/components/responses/ListApplications'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- portalAccessToken: []
tags:
- applications
post:
operationId: create-application
summary: Create an Application
description: Creates a new Application.
requestBody:
$ref: '#/components/requestBodies/CreateApplication'
responses:
'201':
$ref: '#/components/responses/ApplicationCreation'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
security:
- portalAccessToken: []
tags:
- applications
'/api/v2/applications/{applicationId}':
get:
operationId: get-application
summary: Get an Application
description: Gets the details for an existing application. You need only supply the unique application identifier that was returned upon application creation or by the list-applications endpoint.
parameters:
- $ref: '#/components/parameters/ApplicationId'
responses:
'200':
$ref: '#/components/responses/GetApplication'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- applications
delete:
operationId: delete-application
summary: Delete Application
description: Deletes an application and all of its associated entities (registrations).
parameters:
- $ref: '#/components/parameters/ApplicationId'
responses:
'204':
description: Application was deleted successfully.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- portalAccessToken: []
tags:
- applications
patch:
operationId: update-application
summary: Update Application
description: 'Updates an application, replacing specified properties with any new values supplied in the request body.'
parameters:
- $ref: '#/components/parameters/ApplicationId'
requestBody:
$ref: '#/components/requestBodies/UpdateApplication'
responses:
'200':
$ref: '#/components/responses/ApplicationUpdate'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
security:
- portalAccessToken: []
tags:
- applications
'/api/v2/applications/{applicationId}/credentials':
get:
operationId: list-credentials
summary: List credentials
description: Lists the credentials for an application they own.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
responses:
'200':
$ref: '#/components/responses/ListCredentials'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
security:
- portalAccessToken: []
tags:
- credentials
post:
operationId: create-credential
summary: Create Credential for Application
description: Allows a developer to create a credential for an application they own.
parameters:
- $ref: '#/components/parameters/ApplicationId'
requestBody:
$ref: '#/components/requestBodies/CreateCredential'
responses:
'201':
$ref: '#/components/responses/CredentialCreation'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PostCredentials403Response'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- credentials
'/api/v2/applications/{applicationId}/credentials/{credentialId}':
put:
operationId: update-credential
summary: Update Credential
description: Updates a credential for an application owned by the current logged in developer.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/CredentialId'
requestBody:
$ref: '#/components/requestBodies/UpdateCredential'
responses:
'200':
description: Credential successfully updated.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- credentials
delete:
operationId: delete-credential
summary: Delete Credential
description: Deletes a credential for an application they own.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/CredentialId'
responses:
'204':
description: Credential successfully deleted.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
security:
- portalAccessToken: []
tags:
- credentials
'/api/v2/applications/{applicationId}/product-versions/{productVersionId}/granted-scopes':
get:
operationId: get-application-product-version-granted-scopes
summary: Get the granted scopes
description: |
Retrieves the granted scopes of a specified application and product version directly from the IDP.
Scopes shared between product versions will be returned, even if not currently registered for given product version.
Will return 422 if this feature is not supported by the application.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/ProductVersionId'
responses:
'200':
$ref: '#/components/responses/GetGrantedScopesProductVersion'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/GetGrantedScopesProductVersion422Response'
security:
- portalAccessToken: []
tags:
- applications
'/api/v2/applications/{applicationId}/refresh-token':
post:
operationId: refresh-application-token
summary: Refresh Client Secret
description: Resets the client secret for an application.
parameters:
- $ref: '#/components/parameters/ApplicationId'
responses:
'201':
$ref: '#/components/responses/RefreshToken'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- credentials
'/api/v2/applications/{applicationId}/registrations':
get:
operationId: list-application-registrations
summary: Get application registrations
description: Lists product registrations for an application.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/FilterByIdEquality'
- $ref: '#/components/parameters/FilterByIdEqualityShort'
- $ref: '#/components/parameters/FilterByStatusEquality'
- $ref: '#/components/parameters/FilterByStatusEqualityShort'
- $ref: '#/components/parameters/FilterByProductNameEquality'
- $ref: '#/components/parameters/FilterByProductNameEqualityShort'
- $ref: '#/components/parameters/FilterByProductVersionNameEquality'
- $ref: '#/components/parameters/FilterByProductVersionNameEqualityShort'
- $ref: '#/components/parameters/FilterByProductVersionNameContains'
- $ref: '#/components/parameters/FilterByProductNameContains'
responses:
'200':
$ref: '#/components/responses/ListRegistrations'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- registrations
post:
operationId: create-application-registration
summary: Register an application for a product
description: Registers an application for a product.
parameters:
- $ref: '#/components/parameters/ApplicationId'
requestBody:
$ref: '#/components/requestBodies/CreateRegistration'
responses:
'201':
$ref: '#/components/responses/CreateRegistration'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
security:
- portalAccessToken: []
tags:
- registrations
'/api/v2/applications/{applicationId}/registrations/{registrationId}':
get:
operationId: get-application-registration
summary: Get an application registration
description: Retrieves the specified product registration for an application.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/RegistrationId'
responses:
'200':
$ref: '#/components/responses/GetRegistration'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- registrations
delete:
operationId: delete-application-registration
summary: Delete an application registration
description: Unregister an application for a product version.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/RegistrationId'
responses:
'204':
description: The registration has been deleted.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- registrations
'/api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes':
get:
operationId: get-application-registration-granted-scopes
summary: Get the granted scopes of an application registration
description: |
Retrieves the granted scopes of a specified product registration directly from the IDP for an application.
Will return 409 if this feature is not supported by the application.
parameters:
- $ref: '#/components/parameters/ApplicationId'
- $ref: '#/components/parameters/RegistrationId'
responses:
'200':
$ref: '#/components/responses/GetGrantedScopes'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableContent'
security:
- portalAccessToken: []
tags:
- registrations
/api/v2/applications/auth-strategies:
get:
operationId: list-application-auth-strategies
summary: List the available auth strategies
description: |
Retrieve the available Auth Strategies on this portal.
An Auth Strategy is a set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version.
It may reference to Key-Auth or an OIDC configuration (with or without DCR).
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/FilterByNameEquality'
- $ref: '#/components/parameters/FilterByNameEqualityShort'
- $ref: '#/components/parameters/FilterByNameContains'
- $ref: '#/components/parameters/FilterByCredentialTypeEquality'
responses:
'200':
$ref: '#/components/responses/ListAuthStrategies'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- portalAccessToken: []
tags:
- applications
/api/v2/developer:
post:
operationId: register
summary: Register
description: Register to the developer portal.
requestBody:
description: Developer registration
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterPayload'
examples:
RegisterDeveloperRequestExample1:
$ref: '#/components/examples/RegisterDeveloperRequestExample1'
responses:
'201':
description: the developer has been properly registered.
'400':
$ref: '#/components/responses/BadRequest'
security:
- {}
tags:
- developer
/api/v2/developer/authenticate:
post:
operationId: authenticate
summary: Authenticate
description: This endpoint allows a developer to authenticate to their portal using a username and password.
requestBody:
$ref: '#/components/requestBodies/AuthenticateRequest'
responses:
'204':
description: No Content
headers:
Set-Cookie:
schema:
type: string
example: |
portalaccesstoken=access12345; Path=/; Domain=example.us.portal.konghq.com; Expires=Thu, 20 Jul 2023 12:00:00 GMT; HttpOnly; Secure; SameSite=None
portalrefreshtoken=refresh12345; Path=/v2/refresh; Domain=example.us.portal.konghq.com; Expires=Thu, 20 Jul 2023 12:00:00 GMT; HttpOnly; Secure; SameSite=None
description: The access and refresh tokens.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
tags:
- developer
/api/v2/developer/authenticate/sso:
get:
operationId: authenticate-sso
summary: Authenticate SSO
description: This endpoint allows a developer to authenticate to their portal using an external IdP.
responses:
'302':
description: Found
'400':
$ref: '#/components/responses/BadRequest'
tags:
- developer
/api/v2/developer/forgot-password:
post:
operationId: forgot-password
summary: Forgot Password
description: |
Starts the password reset flow for the desired account. An email
will be sent to the email address to initiate the password reset flow.
requestBody:
description: Developer registration
content:
application/json:
schema:
$ref: '#/components/schemas/ResetPasswordPayload'
responses:
'200':
description: the password reset flow has been initiated.
'400':
$ref: '#/components/responses/BadRequest'
security:
- {}
tags:
- developer
/api/v2/developer/logout:
post:
operationId: logout
summary: Logout
description: This endpoint allows a developer to logout of the portal. This operation revokes all active tokens and clears the portal cookies.
responses:
'204':
description: No Content
tags:
- developer
/api/v2/developer/me:
get:
operationId: get-developer-me
summary: Retrieve My Account
description: Returns info about the current developer.
responses:
'200':
$ref: '#/components/responses/MeResponse'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- portalAccessToken: []
tags:
- developer
/api/v2/developer/refresh:
post:
operationId: refresh
summary: Refresh Access Token
description: This endpoint allows a developer to refresh their existing access token.
responses:
'204':
description: No Content
headers:
Set-Cookie:
schema:
type: string
example: |
portalaccesstoken=access12345; Path=/; Domain=example.us.portal.konghq.com; Expires=Thu, 20 Jul 2023 12:00:00 GMT; HttpOnly; Secure; SameSite=None
portalrefreshtoken=refresh12345; Path=/v2/refresh; Domain=example.us.portal.konghq.com; Expires=Thu, 20 Jul 2023 12:00:00 GMT; HttpOnly; Secure; SameSite=None
'401':
$ref: '#/components/responses/responses-Unauthorized'
tags:
- developer
/api/v2/developer/reset-password:
post:
operationId: reset-password
summary: Reset Password
description: 'This endpoint allows a developer to reset their password, using a reset token.'
requestBody:
$ref: '#/components/requestBodies/ResetPasswordRequest'
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/responses-Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- developer
parameters: []
/api/v2/developer/verify-email:
post:
operationId: verify-email
summary: Verify Email
description: This endpoint allows a new developer to verify their email.
requestBody:
$ref: '#/components/requestBodies/VerifyEmailRequest'
responses:
'202':
$ref: '#/components/responses/VerifyEmailResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- developer
parameters: []
/api/v2/portal:
get:
operationId: get-portal-context
summary: Get portal context
description: Return the portal context object.
responses:
'200':
$ref: '#/components/responses/GetPortalContextResponse'
security:
- {}
tags:
- portal
/api/v2/portal/appearance:
get:
operationId: get-portal-appearance
summary: Portal Appearance Details
description: Gets appearance configuration object for the portal. This object is set in Konnect.
responses:
'200':
$ref: '#/components/responses/GetPortalAppearanceResponse'
security:
- {}
tags:
- portal
/api/v2/portal/catalog-cover:
get:
operationId: get-portal-catalog-cover
summary: Portal Catalog Cover Banner
description: Gets cover banner for the developer portal. This object is set in Konnect.
responses:
'200':
$ref: '#/components/responses/GetPortalCoverResponse'
security:
- {}
tags:
- portal
/api/v2/portal/logo:
get:
operationId: get-portal-logo
summary: Portal Logo
description: Gets logo of the developer portal. This object is set in Konnect.
responses:
'200':
$ref: '#/components/responses/GetPortalLogoResponse'
security:
- {}
tags:
- portal
/api/v2/products:
get:
operationId: list-products
summary: List Products
description: Returns a paginated list of published API Products.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/FilterByNameEquality'
- $ref: '#/components/parameters/FilterByNameEqualityShort'
- $ref: '#/components/parameters/FilterByNameContains'
- $ref: '#/components/parameters/FilterByDescriptionEquality'
- $ref: '#/components/parameters/FilterByDescriptionEqualityShort'
- $ref: '#/components/parameters/FilterByDescriptionContains'
- $ref: '#/components/parameters/FilterByIdEquality'
- $ref: '#/components/parameters/FilterByIdEqualityShort'
responses:
'200':
$ref: '#/components/responses/ProductList'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- portalAccessToken: []
- {}
tags:
- products
'/api/v2/products/{productId}':
get:
operationId: get-product
summary: Get a product
description: Gets the details for an existing published product.
parameters:
- $ref: '#/components/parameters/ProductId'
responses:
'200':
$ref: '#/components/responses/ProductGet'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- products
'/api/v2/products/{productId}/actions':
parameters:
- $ref: '#/components/parameters/ProductId'
get:
operationId: get-product-actions
summary: Get Product Actions
description: Get a list of actions that the current developer is allowed to perform on an API product.
responses:
'200':
$ref: '#/components/responses/ProductActions'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'503':
$ref: '#/components/responses/NotAvailable'
tags:
- products
'/api/v2/products/{productId}/documents':
get:
operationId: list-product-documents
summary: List product documents
description: 'Returns a list of documents that are associated with a given product. The list is paginated, and is in either a list or tree format (based on the Accept header).'
parameters:
- $ref: '#/components/parameters/ProductId'
- name: Accept
in: header
schema:
$ref: '#/components/schemas/DocumentContentTypeEnum'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
responses:
'200':
description: Lists documents for a given product.
content:
application/json:
schema:
$ref: '#/components/schemas/ListDocuments'
application/vnd.konnect.document-tree+json:
schema:
$ref: '#/components/schemas/ListDocumentsTree'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- documentation
'/api/v2/products/{productId}/documents/{documentId}':
get:
operationId: get-product-document
summary: Get one product document
description: Returns the specified document from the product's document tree.
parameters:
- name: Accept
in: header
schema:
$ref: '#/components/schemas/DocumentFormatContentTypeEnum'
- $ref: '#/components/parameters/ProductId'
- $ref: '#/components/parameters/DocumentId'
responses:
'200':
$ref: '#/components/responses/ProductDocumentGet'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- documentation
'/api/v2/products/{productId}/versions':
get:
operationId: list-product-versions
summary: Get page of product versions
description: Returns paginated list of versions of a given product.
parameters:
- $ref: '#/components/parameters/ProductId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/FilterByNameEquality'
- $ref: '#/components/parameters/FilterByNameEqualityShort'
- $ref: '#/components/parameters/FilterByNameContains'
responses:
'200':
$ref: '#/components/responses/ProductListVersions'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- versions
'/api/v2/products/{productId}/versions/{productVersionId}':
get:
operationId: get-product-version
summary: Get product version
description: Gets the details for an existing product version.
parameters:
- $ref: '#/components/parameters/ProductId'
- $ref: '#/components/parameters/ProductVersionId'
responses:
'200':
$ref: '#/components/responses/ProductVersionGet'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- versions
'/api/v2/products/{productId}/versions/{productVersionId}/applications':
get:
operationId: get-applications-by-product-version
summary: Get applications by product version
description: |-
Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked).
Use the `unregistered` query param to return the inverse, only including applicatons that do not have a registration (regardless of status).
parameters:
- $ref: '#/components/parameters/ProductId'
- $ref: '#/components/parameters/ProductVersionId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/FilterByNameEquality'
- $ref: '#/components/parameters/FilterByNameEqualityShort'
- $ref: '#/components/parameters/FilterByNameContains'
- $ref: '#/components/parameters/FilterByStatusEquality'
- $ref: '#/components/parameters/FilterByStatusEqualityShort'
- $ref: '#/components/parameters/FilterByAuthStrategyEquality'
- $ref: '#/components/parameters/FilterByAuthStrategyEqualityShort'
- $ref: '#/components/parameters/QueryUnregisteredApplications'
responses:
'200':
$ref: '#/components/responses/ProductVersionListApplications'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
tags:
- versions
'/api/v2/products/{productId}/versions/{productVersionId}/spec':
get:
operationId: get-product-version-spec
summary: Get spec for product version
description: Returns the API specification document attached to given product version. Currently only OpenAPI is supported.
parameters:
- $ref: '#/components/parameters/ProductId'
- $ref: '#/components/parameters/ProductVersionId'
responses:
'200':
$ref: '#/components/responses/ProductVersionSpecGet'
'204':
description: No specification is defined for the version.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- versions
'/api/v2/products/{productId}/versions/{productVersionId}/spec/operations':
get:
operationId: get-product-version-spec-operations
summary: Get operations in version spec
description: Returns list of operations used in the API specification document attached to given product version.
parameters:
- $ref: '#/components/parameters/ProductId'
- $ref: '#/components/parameters/ProductVersionId'
responses:
'200':
$ref: '#/components/responses/ProductVersionSpecOperationsGet'
'204':
description: Response when there are no operations to send because no spec is defined for the version.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- portalAccessToken: []
- {}
tags:
- versions
'/api/v2/search/{indices}':
get:
operationId: search-portal-entities
summary: Search Portal Entities
description: Returns paginated search results from the specified entities with the given search parameters.
parameters:
- $ref: '#/components/parameters/SearchIndices'
- $ref: '#/components/parameters/SearchQuery'
- $ref: '#/components/parameters/SearchJoin'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
responses:
'200':
$ref: '#/components/responses/SearchResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- portalAccessToken: []
- {}
tags:
- search
/api/v2/stats:
post:
operationId: query-application-analytics
summary: Query Application Analytics
description: Query
requestBody:
description: Object describing the query sent to analytics API.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryApplicationAnalytics'
examples:
Query with a single metric:
$ref: '#/components/examples/QueryExampleWithMetric'
Query with a metric and dimension:
$ref: '#/components/examples/QueryExampleWithMetricAndDimension'
Query with a metric and two dimensions:
$ref: '#/components/examples/QueryExampleWithMetricAndMultipleDimensions'
Query with time dimension:
$ref: '#/components/examples/QueryExampleWithTimeDimension'
responses:
'200':
$ref: '#/components/responses/QueryResponse'
'400':
description: Bad Request
content:
application/problem+json:
examples:
BadRequestExample:
$ref: '#/components/examples/BadRequestExample'
'401':
description: Unauthorized
content:
application/problem+json:
examples:
UnauthorizedExample:
$ref: '#/components/examples/UnauthorizedExample'
'403':
$ref: '#/components/responses/Forbidden'
security:
- portalAccessToken: []
tags:
- Application Analytics
/api/v2/stats/config:
get:
operationId: get-application-analytics-config
summary: Application Analytics Config
description: Get config for application analytics
responses:
'200':
$ref: '#/components/responses/GetConfig'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- portalAccessToken: []
tags:
- Application Analytics
components:
parameters:
ApplicationId:
name: applicationId
in: path
required: true
description: Id of the targeted application
schema:
type: string
format: uuid
CredentialId:
name: credentialId
in: path
required: true
description: Id of the targeted credential
schema:
type: string
format: uuid
DocumentId:
name: documentId
in: path
required: true
description: Contains a unique identifier used by the Portal API for this resource.
schema:
type: string
format: uuid
FilterByAuthStrategyEquality:
name: 'filter[auth_strategy_id][eq]'
description: Filter by the id of the auth strategy supported by the application.
in: query
required: false
schema:
type: string
example: 5be86298-147b-45ab-bfaf-a1bff97dce39
FilterByAuthStrategyEqualityShort:
name: 'filter[auth_strategy_id]'
description: Filter by the id of the auth strategy supported by the application (short-hand).
in: query
required: false
schema:
type: string
example: 5be86298-147b-45ab-bfaf-a1bff97dce39
FilterByCredentialTypeEquality:
name: 'filter[credential_type][eq]'
description: Filter by direct equality comparison of the credential_type with a supplied value.
in: query
required: false
schema:
type: string
example: key_auth
enum:
- client_credentials