-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1486 lines (1426 loc) · 47.2 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: sc-agent
description: API to interact with sc-agent
version: 1.0.0
contact:
name: soeren schneider
url: https://github.com/soerenschneider/sc-agent
email: "[email protected]" # this is just for linting reasons
license:
name: "NONE" # this is just for linting reasons
url: "none" # this is just for linting reasons
servers:
- url: http://localhost:9999
description: Local server
tags:
- name: acme
description: Tag for acme related endpoints
- name: certs
description: Tag for certs related endpoints
- name: info
description: Meta information about the instance
- name: k0s
description: Tag for k0s related endpoints
- name: libvirt
description: Tag for libvirt related endpoints
- name: packages
description: Tag for packages related endpoints
- name: pki
description: Tag for PKI related endpoints
- name: secrets
description: Tag for secret syncer related endpoints
- name: services
description: Tag for service related endpoints
- name: ssh
description: Tag for SSH related endpoints
- name: power
description: Tag for power-state related endpoints
- name: wol
description: Tag for Wake-on-LAN (WOL) related endpoints
- name: x509
description: Tag for x509 related endpoints
paths:
/v1/certs/acme:
get:
operationId: certsAcmeGetCertificates
summary: "Returns current configuration"
description: Returns the current configuration of the secret replication component.
tags:
- acme
- certs
responses:
'200':
description: The current configuration of the secret syncer
content:
application/json:
schema:
$ref: "#/components/schemas/AcmeManagedCertificateList"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/acme/{id}:
get:
operationId: certsAcmeGetCertificate
summary: "Returns the replication status of a single item"
description: >
Returns the replication status of a single secret replication item. The id of the item is passed via path
variable.
tags:
- acme
- certs
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "prod/db"
description: The id which translates to the secret path of the to-be-synced item in Vault.
responses:
'200':
description: Object containing the status
content:
application/json:
schema:
$ref: "#/components/schemas/AcmeManagedCertificate"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/ssh:
get:
operationId: certsSshGetCertificates
summary: Get the configuration of all managed ssh certificates
description: >
Returns a list of all configured managed ssh certificates.
tags:
- certs
- ssh
parameters:
- name: type
in: query
required: false
schema:
type: string
enum:
- user
- host
example: "user"
description: Specifies whether to return cert of type user or host. See Vault documentation.
responses:
'200':
description: Object that contains the list of all configured certs
content:
application/json:
schema:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/SshManagedCertificatesList'
description: Array holding conf
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/ssh/{id}:
get:
operationId: certsSshGetCertificate
summary: Get the configuration of a single managed ssh certificate
description: >
Returns the configuration of a managed ssh certificates for a given id. The parameter id is supplied via path.
tags:
- certs
- ssh
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "my-host-cert"
description: The id of the SSH certificate you want to retrieve information for
responses:
'200':
description: Configuration of the managed ssh certificate.
content:
application/json:
schema:
$ref: "#/components/schemas/SshManagedCertificate"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/ssh/issue-requests:
post:
operationId: certsSshPostIssueRequests
summary: Sign a SSH public key
description: >
Signs a SSH public key and writes the signature to a file. The appropriate public key is picked from the configuration and is passed via path parameter. The public key is only signed if
a signature does not exist already or if the configured threshold of the remaining lifetime is exceeded.
tags:
- certs
- ssh
parameters:
- name: id
in: query
required: true
schema:
type: string
example: "my-user-cert"
description: The id of the SSH host certificate you want to sign
- name: force-renewal
in: query
required: false
schema:
type: boolean
description: Do not check the lifetime of the existing certificate against the threshold and force a new signature of the host key
responses:
'200':
description: Certificate already exists and is still valid, no new signature was needed
'201':
description: New signature created, either because certificate did not exist, was expired, was below the lifetime threshold or because force_renewal was set to true.
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/x509/issue-requests:
post:
operationId: certsX509PostIssueRequests
summary: Issues a X509 certificate
description: Issues a X509 certificate
tags:
- certs
- x509
parameters:
- name: id
in: query
required: true
schema:
type: string
example: "my-user-cert"
description: The id of the SSH host certificate you want to sign
- name: force-renewal
in: query
required: false
schema:
type: boolean
description: Do not check the lifetime of the existing certificate against the threshold and force a new signature of the host key
responses:
'200':
description: Certificate already exists and is still valid, no new signature was needed
'201':
description: New signature created, either because certificate did not exist, was expired, was below the lifetime threshold or because force_renewal was set to true.
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/x509:
get:
operationId: certsX509GetCertificatesList
summary: Return configuration of all managed x509 certificates
description: >
Returns a list of all configured managed x509 certificates.
tags:
- certs
- x509
responses:
'200':
description: Configuration of all managed x509 certificates
content:
application/json:
schema:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/X509ManagedCertificateList'
description: List of managed certificate configs
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/certs/x509/{id}:
get:
operationId: certsX509GetCertificate
summary: Returns info of configured managed x509 certificate
description: Accepts the id of the configured managed x509 certificate as path parameter and returns its config.
tags:
- certs
- x509
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "my-id"
description: The id of the managed x509 certificate you want to retrieve configuration for
responses:
'200':
description: Info about the managed x509 cert
content:
application/json:
schema:
$ref: "#/components/schemas/X509ManagedCertificate"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/info/components:
get:
operationId: infoGetComponents
summary: Returns all enabled components
description: >
A list of the components that are enabled on this instance
tags:
- info
responses:
'200':
description: List of all enabled components
content:
application/json:
schema:
$ref: "#/components/schemas/InfoComponents"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/k0s/actions:
post:
operationId: k0sPostAction
summary: Start k0s
description: Start the k0s service.
tags:
- k0s
parameters:
- name: action
in: query
required: true
schema:
type: string
enum:
- stop
- start
example: "stop"
description: Action to perform for the k0s service
responses:
'200':
description: Command to start k0s was invoked successfully
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/packages/installed:
get:
operationId: packagesInstalledGet
summary: Lists installed packages
description: List all installed packages that are installed via the system's package manager.
tags:
- packages
responses:
'200':
description: A list of packages installed via DNF/RPM on the system
content:
application/json:
schema:
$ref: '#/components/schemas/PackagesInstalled'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/packages/updates:
get:
operationId: packagesUpdatesGet
summary: Checks for updates
description: Checks if any packages are updateable via DNF
tags:
- packages
responses:
'200':
description: Returns whether updates are available for packages installed via DNF
content:
application/json:
schema:
$ref: '#/components/schemas/PackageUpdates'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/packages/upgrade-requests:
post:
operationId: packagesUpgradeRequestsPost
summary: Upgrades all packages
description: Upgrades all packages with the default package manager. It is not recommend to use this endpoint on a regular basis.
tags:
- packages
responses:
'200':
description: Upgrade was successful
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/libvirt/domains/{domain}:
post:
operationId: libvirtPostDomainAction
summary: Set status of libvirt domain
description: >
Interact with the status of a libvirt domain running on the machine the API runs on. Both domain name and
action are set as path variable.
tags:
- libvirt
parameters:
- name: domain
in: path
required: true
schema:
type: string
description: The name of the domain you want to shutdown
example: example-domain
- name: action
in: query
required: true
schema:
type: string
enum:
- reboot
- shutdown
- start
example: reboot
description: Action to perform for the libvirt domain
responses:
'200':
description: Domain shutdown successful
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/power-state/reboot-manager:
put:
operationId: powerRebootManagerPostStatus
summary: Unpause reboot status
description: Set the pause status of the reboot manager service
tags:
- power
parameters:
- name: "action"
in: "query"
required: true
schema:
type: "string"
enum:
- "pause"
- "unpause"
example: "pause"
description: Action to perform for the reboot-manager service
responses:
'200':
description: Reboot status unpaused
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/power-state/reboot-manager/status:
get:
operationId: powerRebootManagerGetStatus
summary: Get reboot status
description: Return the current reboot status.
tags:
- power
responses:
'200':
description: Reboot status retrieved successfully
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: paused
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/power-state:
post:
operationId: powerPostAction
summary: Directly interact with the power status of the system
description: >
Send an action to the local system that either tries to shutdown or reboot the machine this API is running on.
The appropriate action is set via path variable.
tags:
- power
parameters:
- name: action
in: query
required: true
schema:
type: string
enum:
- reboot
- shutdown
example: reboot
description: Action to perform for the machine
responses:
'200':
description: Machine shutdown successful
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/replication/http/items:
get:
operationId: replicationGetHttpItemsList
summary: "Returns current configuration"
description: Returns the current configuration of the secret replication component.
tags:
- secrets
responses:
'200':
description: The current configuration of the secret syncer
content:
application/json:
schema:
$ref: "#/components/schemas/ReplicationHttpItemsList"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/replication/http/items/{id}:
get:
operationId: replicationGetHttpItem
summary: "Returns the replication status of a single item"
description: >
Returns the replication status of a single secret replication item. The id of the item is passed via path
variable.
tags:
- secrets
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "prod/db"
description: The id which translates to the secret path of the to-be-synced item in Vault.
responses:
'200':
description: Object containing the status
content:
application/json:
schema:
$ref: "#/components/schemas/ReplicationHttpItem"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/replication/secrets/sync-requests:
post:
operationId: replicationPostSecretsRequests
summary: Replicate a secret from Vault
description: >
Replicates a predefined secret from Vault to the local filesystem. The secret config is defined by the secret path which is expected as query parameter.
tags:
- secrets
parameters:
- name: secret-path
in: query
required: true
schema:
type: string
example: "prod/database"
description: The KV2 path of the secret that you want to trigger the sync for
responses:
'200':
description: "Successfully synced secret"
'201':
description: "Updated secret"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/replication/secrets/items:
get:
operationId: replicationGetSecretsItemsList
summary: "Returns current configuration"
description: Returns the current configuration of the secret replication component.
tags:
- secrets
responses:
'200':
description: The current configuration of the secret syncer
content:
application/json:
schema:
$ref: "#/components/schemas/ReplicationSecretsItemsList"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/replication/secrets/items/{id}:
get:
operationId: replicationGetSecretsItem
summary: "Returns the replication status of a single item"
description: >
Returns the replication status of a single secret replication item. The id of the item is passed via path
variable.
tags:
- secrets
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "prod/db"
description: The id which translates to the secret path of the to-be-synced item in Vault.
responses:
'200':
description: Object containing the status
content:
application/json:
schema:
$ref: "#/components/schemas/ReplicationSecretsItem"
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/services/{unit}/status:
put:
operationId: servicesUnitStatusPut
summary: Interact with a system service
description: Interacts with a system service. Unit and action are set via path.
tags:
- services
parameters:
- name: unit
in: path
required: true
schema:
type: string
description: The name of the system service unit to be restarted
example: sshd.service
- name: action
in: query
required: true
schema:
type: string
enum:
- restart
- stop
- start
example: start
description: Action to perform for the system service unit
responses:
'200':
description: Action carried out successfully to system service unit
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/services/{unit}/logs:
get:
operationId: servicesUnitLogsGet
summary: Get logs of a system service unit
description: Retrieve logs for a system unit. The unit must be provided in the path.
tags:
- services
parameters:
- name: unit
description: The name of the system service unit to request logs for
in: path
required: true
schema:
type: string
example: "sshd.service"
responses:
'200':
description: Logs retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceLogsData'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
/v1/wol-message/{alias}:
post:
operationId: wolPostMessage
summary: Send a WOL packet
description: Craft a WOL packet that wakes up a machine using Wake-on-LAN. The alias must be provided by path.
tags:
- wol
parameters:
- name: alias
in: path
required: true
schema:
type: string
example: notebook
description: The configured alias of the machine to send a WOL packet to
responses:
'200':
description: Machine wakeup signal sent successfully
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
components:
schemas:
Problem:
description: A generic HTTP problem
properties:
type:
type: "string"
description: "A URI reference that identifies the problem type"
example: "https://example.com/probs/out-of-credit"
title:
type: "string"
description: "A short, human-readable summary of the problem type"
example: "You do not have enough credit."
detail:
type: "string"
description: "A human-readable explanation specific to this occurrence of the problem"
example: "Your current balance is 30, but that costs 50."
instance:
type: "string"
description: "A URI reference that identifies the specific occurrence of the problem"
example: "/account/12345/msgs/abc"
status:
type: "integer"
description: "The HTTP status code"
example: 400
example:
type: "https://example.com/probs/out-of-credit"
title: "You do not have enough credit."
detail: "You do not have enough credit."
instance: "/account/12345/msgs/abc"
status: 400
AcmeManagedCertificateList:
type: object
title: AcmeManagedCertificateList
description: "The configuration of all configured managed ACME certificates"
properties:
data:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/AcmeManagedCertificate'
description: The sync items
AcmeManagedCertificate:
type: object
title: AcmeManagedCertificateList
description: "The configuration of the managed ACME certificate"
properties:
certificate:
$ref: '#/components/schemas/X509CertificateData'
certificate_config:
$ref: '#/components/schemas/X509CertificateConfig'
storage_config:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/X509CertificateStorage'
post_hooks:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/PostHooks'
ReplicationHttpItem:
type: object
title: HttpReplicationItem
description: "Configuration and status of a single HTTP replication item"
properties:
id:
type: string
example: "ca-crt"
x-go-type-skip-optional-pointer: true
description: id of the item
source:
type: string
example: "prod/db"
x-go-type-skip-optional-pointer: true
description: path of the secret to read and sync to the local filesystem
dest_uris:
type: array
example: ["/etc/certs/pki-ca.crt", "/etc/haproxy/pki-ca.crt"]
x-go-type-skip-optional-pointer: true
description: destination path where the read secret should be writen to
maxItems: 100
items:
type: string
expected_checksum:
type: string
example: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
description: only save the file if the checksum matches
status:
type: string
example: "synced"
x-go-type-skip-optional-pointer: true
description: the status of the synced secret
enum:
- unknown
- synced
- failed
- invalid_checksum
post_hooks:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/PostHooks'
ReplicationHttpItemsList:
type: object
title: SecretReplicationItems
description: "All managed HTTP replication items"
properties:
data:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/ReplicationHttpItem'
description: The sync items
example:
data:
- secret_path: "prod/db"
formatter: "json"
dest_uri: "/tmp/db.json"
ReplicationSecretsItemsList:
type: object
title: SecretReplicationItems
description: "The configuration of all configured managed secrets replication items"
properties:
data:
type: array
x-go-type-skip-optional-pointer: true
items:
$ref: '#/components/schemas/ReplicationSecretsItem'
description: The sync items
example:
data:
- secret_path: "prod/db"
formatter: "json"
dest_uri: "/tmp/db.json"
ReplicationSecretsItem:
type: object
title: SecretReplicationItem
description: "Configuration and status of a single secret replication item"
properties:
id:
type: string
example: "database"
x-go-type-skip-optional-pointer: true
description: id of the item
secret_path:
type: string
example: "prod/db"
x-go-type-skip-optional-pointer: true
description: path of the secret to read and sync to the local filesystem
formatter:
type: string
example: "json"
x-go-type-skip-optional-pointer: true
description: name of the formatter
dest_uri:
type: string
example: "/tmp/db.json"
x-go-type-skip-optional-pointer: true