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