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