forked from Kong/kong
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kong-admin-api.yml
765 lines (765 loc) · 18.6 KB
/
kong-admin-api.yml
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
openapi: 3.1.0
info:
version: 3.4.0
contact:
name: Kong
url: https://github.com/Kong/kong
title: Kong Admin API
license:
name: Apache 2.0
url: https://github.com/Kong/kong/blob/master/LICENSE
summary: Kong RESTful Admin API for administration purposes.
description: " {{site.base_gateway}} comes with an **internal** RESTful Admin
API for administration purposes.\n Requests to the Admin API can be sent
to any node in the cluster, and Kong will\n keep the configuration consistent
across all nodes.\n\n - `8001` is the default port on which the Admin API
listens.\n - `8444` is the default port for HTTPS traffic to the Admin
API.\n\n This API is designed for internal use and provides full control
over Kong, so\n care should be taken when setting up Kong environments
to avoid undue public\n exposure of this API. See [this document][secure-admin-api]
for a discussion\n of methods to secure the Admin API.\n "
paths:
/certificates/{certificates}/snis: []
/schemas/{db_entity_name}/validate:
post:
description: This method is not available when using DB-less mode.
summary: Validate a configuration against a schema
/targets/{targets}: []
/targets/{targets}/upstream: []
/certificates/{certificates}:
get: []
put:
description: This method is not available when using DB-less mode.
patch:
description: This method is not available when using DB-less mode.
/debug/node/log-level:
get:
summary: Retrieve node log level of a node
/upstreams/{upstreams}/health:
get:
summary: Show Upstream health for node
/consumers/{consumers}/plugins:
post:
description: This method is not available when using DB-less mode.
/services/{services}/plugins:
post:
description: This method is not available when using DB-less mode.
/schemas/plugins/{name}:
get:
summary: Retrieve Plugin Schema
/upstreams/{upstreams}/targets/all:
get:
summary: List all Targets
/schemas/{name}:
get:
summary: Retrieve Entity Schema
/plugins/enabled:
get:
summary: Retrieve Enabled Plugins
/tags/{tags}:
get:
summary: ' List entity IDs by tag '
/snis/{snis}/certificate: []
/endpoints:
get:
summary: List available endpoints
/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/routes/{routes}/plugins:
post:
description: This method is not available when using DB-less mode.
/cache:
delete:
description: This method is not available when using DB-less mode.
/services/:services/plugins/:plugins:
patch: []
/consumers:
get: []
/consumers/{consumers}/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/upstreams/{upstreams}/targets/{targets}:
get: []
put:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
summary: Delete Target
patch:
description: This method is not available when using DB-less mode.
summary: Update Target
/upstreams/{upstreams}/targets/{targets}/healthy:
put:
description: This method is not available when using DB-less mode.
summary: Set target as healthy
/debug/node/log-level/{log_level}:
put:
description: This method is not available when using DB-less mode.
summary: Set log level of a single node
/upstreams/{upstreams}/targets/{targets}/{address}/unhealthy:
put:
description: This method is not available when using DB-less mode.
summary: Set target address as unhealthy
/upstreams/{upstreams}/targets/{targets}/unhealthy:
put:
description: This method is not available when using DB-less mode.
summary: Set target as unhealthy
/certificates/{certificates}/snis/{snis}: []
/upstreams/{upstreams}/targets:
get: []
post:
description: This method is not available when using DB-less mode.
/upstreams/{upstreams}/targets/{targets}/{address}/healthy:
put:
description: This method is not available when using DB-less mode.
summary: Set target address as healthy
/cache/{key}:
delete:
description: This method is not available when using DB-less mode.
get: []
/:
get:
summary: Retrieve node information
/debug/cluster/log-level/{log_level}:
put:
description: This method is not available when using DB-less mode.
summary: Set node log level of all nodes
/schemas/plugins/validate:
post:
description: This method is not available when using DB-less mode.
summary: Validate a plugin configuration against the schema
/clustering/status: []
/timers:
get:
summary: Retrieve runtime debugging info of Kong's timers
/targets: []
/status:
get:
summary: Retrieve node status
/plugins:
post:
description: This method is not available when using DB-less mode.
/clustering/data-planes: []
/config:
get:
description: This method is only available when using DB-less mode.
post:
description: This method is only available when using DB-less mode.
/routes/{routes}/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/filter-chains:
post:
description: This method is not available when using DB-less mode.
/filter-chains/{filter_chains}:
patch:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
/services/{services}/filter-chains:
post:
description: This method is not available when using DB-less mode.
/services/{services}/filter-chains/{filter_chains}:
patch:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
/routes/{routes}/filter-chains:
post:
description: This method is not available when using DB-less mode.
/routes/{routes}/filter-chains/{filter_chains}:
patch:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
components:
schemas:
key_sets:
type: object
properties:
id:
format: uuid
type: string
tags:
type: array
name:
type: string
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required: []
clustering_data_planes:
type: object
properties:
version:
type: string
last_seen:
format: int32
type: integer
config_hash:
type: string
sync_status:
default: unknown
type: string
id:
type: string
updated_at:
format: int32
type: integer
hostname:
type: string
ip:
type: string
required:
- id
- ip
- hostname
- sync_status
parameters:
type: object
properties:
value:
type: string
created_at:
format: int32
type: integer
key:
type: string
required:
- key
- value
plugins:
type: object
properties:
config:
type: array
consumer:
nullable: true
$ref: '#/components/schemas/consumers'
default: ~
enabled:
default: true
type: boolean
protocols:
enum:
- http
- https
- tcp
- tls
- udp
- grpc
- grpcs
type: array
default:
- grpc
- grpcs
- http
- https
instance_name:
type: string
id:
format: uuid
type: string
tags:
type: array
updated_at:
format: int32
type: integer
name:
type: string
route:
nullable: true
$ref: '#/components/schemas/routes'
default: ~
created_at:
format: int32
type: integer
service:
nullable: true
$ref: '#/components/schemas/services'
default: ~
required:
- name
- protocols
- enabled
tags:
type: object
properties:
entity_name:
type: string
entity_id:
type: string
tag:
type: string
required:
- tag
- entity_name
- entity_id
services:
type: object
properties:
retries:
default: 5
type: integer
connect_timeout:
default: 60000
type: integer
tags:
type: array
write_timeout:
default: 60000
type: integer
read_timeout:
default: 60000
type: integer
created_at:
format: int32
type: integer
client_certificate:
$ref: '#/components/schemas/certificates'
protocol:
default: http
type: string
tls_verify_depth:
nullable: true
type: integer
default: ~
host:
type: string
port:
default: 80
type: integer
enabled:
default: true
type: boolean
ca_certificates:
type: array
updated_at:
format: int32
type: integer
id:
format: uuid
type: string
path:
type: string
name:
type: string
tls_verify:
type: boolean
required:
- protocol
- host
- port
- enabled
routes:
type: object
properties:
strip_path:
default: true
type: boolean
https_redirect_status_code:
default: 426
type: integer
path_handling:
default: v0
type: string
hosts:
type: array
methods:
type: array
paths: []
protocols:
default:
- http
- https
type: array
sources:
type: array
id:
format: uuid
type: string
tags:
type: array
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
headers:
type: array
regex_priority:
default: 0
type: integer
preserve_host:
default: false
type: boolean
destinations:
type: array
request_buffering:
default: true
type: boolean
snis:
type: array
response_buffering:
default: true
type: boolean
name:
type: string
service:
$ref: '#/components/schemas/services'
required:
- protocols
- https_redirect_status_code
- strip_path
- preserve_host
- request_buffering
- response_buffering
consumers:
type: object
properties:
custom_id:
type: string
id:
format: uuid
type: string
tags:
type: array
username:
type: string
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required: []
workspaces:
type: object
properties:
id:
format: uuid
type: string
config:
type: array
meta:
type: array
name:
type: string
comment:
type: string
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required:
- name
certificates:
type: object
properties:
key_alt:
type: string
id:
format: uuid
type: string
tags:
type: array
key:
type: string
cert_alt:
type: string
updated_at:
format: int32
type: integer
created_at:
format: int32
type: integer
cert:
type: string
required:
- cert
- key
ca_certificates:
type: object
properties:
id:
format: uuid
type: string
tags:
type: array
cert_digest:
type: string
updated_at:
format: int32
type: integer
created_at:
format: int32
type: integer
cert:
type: string
required:
- cert
snis:
type: object
properties:
id:
format: uuid
type: string
tags:
type: array
certificate:
$ref: '#/components/schemas/certificates'
name:
type: string
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required:
- name
- certificate
upstreams:
type: object
properties:
hash_on:
default: none
type: string
hash_fallback:
default: none
type: string
hash_on_header:
type: string
hash_fallback_header:
type: string
id:
format: uuid
type: string
tags:
type: array
hash_on_cookie_path:
default: /
type: string
hash_on_query_arg:
type: string
created_at:
format: int32
type: integer
hash_fallback_query_arg:
type: string
hash_on_uri_capture:
type: string
hash_fallback_uri_capture:
type: string
host_header:
type: string
use_srv_name:
default: false
type: boolean
client_certificate:
$ref: '#/components/schemas/certificates'
healthchecks:
default:
active:
healthy:
interval: 0
http_statuses:
- 200
- 302
successes: 0
concurrency: 10
unhealthy:
interval: 0
http_statuses:
- 429
- 404
- 500
- 501
- 502
- 503
- 504
- 505
tcp_failures: 0
timeouts: 0
http_failures: 0
timeout: 1
http_path: /
type: http
https_verify_certificate: true
passive:
healthy:
http_statuses:
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 226
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
successes: 0
type: http
unhealthy:
tcp_failures: 0
timeouts: 0
http_statuses:
- 429
- 500
- 503
http_failures: 0
type: array
hash_on_cookie:
type: string
updated_at:
format: int32
type: integer
slots:
default: 10000
type: integer
name:
type: string
algorithm:
default: round-robin
type: string
required:
- name
targets:
type: object
properties:
weight:
default: 100
type: integer
id:
format: uuid
type: string
tags:
type: array
upstream:
$ref: '#/components/schemas/upstreams'
target:
type: string
created_at:
format: float
type: number
updated_at:
format: float
type: number
required:
- upstream
- target
vaults:
type: object
properties:
description:
type: string
id:
format: uuid
type: string
prefix:
type: string
tags:
type: array
config:
type: array
created_at:
format: int32
type: integer
name:
type: string
updated_at:
format: int32
type: integer
required:
- prefix
- name
keys:
type: object
properties:
kid:
type: string
jwk:
type: string
id:
format: uuid
type: string
tags:
type: array
pem: []
set:
$ref: '#/components/schemas/key_sets'
name:
type: string
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required:
- kid
filter_chains:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
enabled:
type: boolean
default: true
filters:
type: array
items:
$ref: '#/components/schemas/filters'
service:
nullable: true
$ref: '#/components/schemas/services'
default: ~
route:
nullable: true
$ref: '#/components/schemas/routes'
default: ~
tags:
type: array
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required: []
filters:
properties:
name:
type: string
config:
type: string
enabled:
type: boolean
default: true
required:
- name
servers:
- description: 8001 is the default port on which the Admin API listens.
url: http://localhost:8001
- description: 8444 is the default port for HTTPS traffic to the Admin API.
url: https://localhost:8444