-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
5910 lines (5658 loc) · 217 KB
/
Copy pathopenapi.yaml
File metadata and controls
5910 lines (5658 loc) · 217 KB
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
# OpenWatch — Stage-0 OpenAPI manifest.
#
# Self-contained 3-endpoint surface that oapi-codegen turns into typed
# Go server stubs. The full 14-domain manifest lives in openapi.full.yaml
# for Stage 2+ reference.
#
# Endpoints:
# GET /api/v1/health — anonymous liveness probe
# POST /api/v1/diagnostics:echo — exercises idempotency + audit
# GET /api/v1/audit/events — cursor-paginated audit list
#
# Specs:
# app/specs/api/health.spec.yaml
# app/specs/api/diagnostics-echo.spec.yaml
# app/specs/api/audit-events-query.spec.yaml
openapi: 3.0.3
info:
title: OpenWatch (Stage 0)
version: 0.1.0-alpha.1
description: |
Stage 0 walking-skeleton surface — three endpoints that exercise the
foundation stack (correlation, idempotency, audit, error envelope).
servers:
- url: https://localhost:8443
description: Local development
paths:
/api/v1/auth/login:
post:
operationId: postAuthLogin
summary: Username/password login with optional TOTP
security: []
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/AuthLoginRequest'}
responses:
'200':
description: Login succeeded; tokens issued
content:
application/json:
schema: {$ref: '#/components/schemas/AuthLoginResponse'}
'401':
description: Invalid credentials or MFA required
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/auth/logout:
post:
operationId: postAuthLogout
summary: Revoke the calling session
responses:
'204':
description: Session revoked
/api/v1/auth/refresh:
post:
operationId: postAuthRefresh
summary: Rotate the refresh token; mint a new access+refresh pair
security: []
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/AuthRefreshRequest'}
responses:
'200':
description: New token pair issued
content:
application/json:
schema: {$ref: '#/components/schemas/AuthLoginResponse'}
'401':
description: Refresh token invalid, expired, or reused (cascade revoke triggered)
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/auth/refresh-cookie:
post:
operationId: postAuthRefreshCookie
summary: Rotate the refresh cookie and mint a new session (browser flow)
description: >
Reads the HttpOnly `openwatch_refresh` cookie, rotates the underlying
refresh token, mints a new session, and Set-Cookies both the rotated
refresh cookie and a fresh `openwatch_session`. Used by the browser
API client as the transparent on-401 retry hook so users with a live
refresh window don't get bounced to /login on every inactivity timeout.
security: []
responses:
'200':
description: Cookies rotated; identity returned
content:
application/json:
schema: {$ref: '#/components/schemas/AuthMeResponse'}
'401':
description: Refresh cookie missing, invalid, expired, or reused. Both auth cookies are cleared.
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/auth/me:
get:
operationId: getAuthMe
summary: Return the calling identity
responses:
'200':
description: Identity
content:
application/json:
schema: {$ref: '#/components/schemas/AuthMeResponse'}
'401':
description: No valid session or bearer
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/users/me/preferences:
get:
operationId: getUsersMePreferences
summary: Return the calling user's UI preferences
description: >
Per-user UI preferences (e.g. the /hosts grid-vs-table default).
Self-scoped — any authenticated identity reads its own; no special
permission. Unset keys are simply absent (the client falls back to
its defaults). Spec system-user-preferences + api-user-preferences.
responses:
'200':
description: The caller's stored preferences
content:
application/json:
schema: {$ref: '#/components/schemas/UserPreferences'}
'401':
description: No valid session or bearer
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
patch:
operationId: patchUsersMePreferences
summary: Merge a partial update into the calling user's UI preferences
description: >
Shallow-merges the provided keys into the caller's stored
preferences and returns the merged result. Only the keys present in
the body are changed; omitted keys are retained. Self-scoped.
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/UserPreferences'}
responses:
'200':
description: The merged preferences
content:
application/json:
schema: {$ref: '#/components/schemas/UserPreferences'}
'400':
description: Malformed body
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'401':
description: No valid session or bearer
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/auth/mfa:enroll:
post:
operationId: postAuthMFAEnroll
summary: Enroll the calling user in TOTP MFA
responses:
'200':
description: Provisioning URI returned for the authenticator app
content:
application/json:
schema: {$ref: '#/components/schemas/AuthMFAEnrollResponse'}
/api/v1/auth/mfa:verify:
post:
operationId: postAuthMFAVerify
summary: Confirm an enrolled MFA secret by verifying a generated OTP
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/AuthMFAVerifyRequest'}
responses:
'204':
description: MFA verified
'401':
description: MFA OTP invalid or replayed
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/auth/password:change:
post:
operationId: postAuthPasswordChange
summary: Change the calling user's password
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/AuthPasswordChangeRequest'}
responses:
'204':
description: Password updated
'401':
description: Current password wrong
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'400':
description: New password rejected by policy
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/health:
get:
operationId: getHealth
summary: Liveness + readiness probe (anonymous)
security: []
responses:
'200':
description: Service is healthy
content:
application/json:
schema: {$ref: '#/components/schemas/HealthResponse'}
'503':
description: Service is degraded or unavailable
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/version:
get:
operationId: getVersion
summary: Build/version metadata (anonymous)
security: []
responses:
'200':
description: Version metadata for this deployment
content:
application/json:
schema: {$ref: '#/components/schemas/VersionResponse'}
/api/v1/diagnostics:echo:
post:
operationId: postDiagnosticsEcho
summary: Echo the request message; exercises idempotency + audit
parameters:
- name: Idempotency-Key
in: header
required: true
schema: {type: string, minLength: 1, maxLength: 255}
- name: X-Correlation-Id
in: header
required: false
schema: {type: string}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/EchoRequest'}
responses:
'200':
description: Echo succeeded
content:
application/json:
schema: {$ref: '#/components/schemas/EchoResponse'}
'400':
$ref: '#/components/responses/BadRequest'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'409':
description: Idempotency-Key reused with different body
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/license:
get:
operationId: getLicense
summary: Get the current license state (tier, features, quotas, status)
responses:
'200':
description: License state
content:
application/json:
schema: {$ref: '#/components/schemas/LicenseStateResponse'}
/api/v1/admin/license:verify:
post:
operationId: postAdminLicenseVerify
summary: Dry-run validate a JWT license without installing it
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/LicenseVerifyRequest'}
responses:
'200':
description: Verification result (success or typed failure)
content:
application/json:
schema: {$ref: '#/components/schemas/LicenseVerifyResponse'}
/api/v1/diagnostics:premium-echo:
post:
operationId: postDiagnosticsPremiumEcho
summary: License-gated echo; requires premium_diagnostics feature
x-required-feature: premium_diagnostics
parameters:
- name: Idempotency-Key
in: header
required: true
schema: {type: string, minLength: 1, maxLength: 255}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/EchoRequest'}
responses:
'200':
description: Echoed
content:
application/json:
schema: {$ref: '#/components/schemas/EchoResponse'}
'402':
description: License does not include premium_diagnostics feature
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/diagnostics:require-host-read:
post:
operationId: postDiagnosticsRequireHostRead
summary: Stage-0 RBAC demo; requires host:read permission
x-required-permission: host:read
parameters:
- name: Idempotency-Key
in: header
required: true
schema: {type: string, minLength: 1, maxLength: 255}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/EchoRequest'}
responses:
'200':
description: Echoed (caller holds host:read)
content:
application/json:
schema: {$ref: '#/components/schemas/EchoResponse'}
'403':
description: Caller lacks host:read
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/diagnostics:require-host-write:
post:
operationId: postDiagnosticsRequireHostWrite
summary: Stage-0 RBAC demo; requires host:write permission
x-required-permission: host:write
parameters:
- name: Idempotency-Key
in: header
required: true
schema: {type: string, minLength: 1, maxLength: 255}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/EchoRequest'}
responses:
'200':
description: Echoed (caller holds host:write)
content:
application/json:
schema: {$ref: '#/components/schemas/EchoResponse'}
'403':
description: Caller lacks host:write
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/diagnostics:evaluate-alert:
post:
operationId: postDiagnosticsEvaluateAlert
summary: Stage-0 policy demo; evaluates the alert_thresholds policy
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/EvaluateAlertRequest'}
responses:
'200':
description: Policy decision
content:
application/json:
schema: {$ref: '#/components/schemas/PolicyDecisionResponse'}
/api/v1/diagnostics:enqueue-test-job:
post:
operationId: postDiagnosticsEnqueueTestJob
summary: Stage-0 queue demo; enqueues a no-op job processed by the in-process worker
responses:
'202':
description: Job accepted; worker will drain
content:
application/json:
schema: {$ref: '#/components/schemas/EnqueueTestJobResponse'}
/api/v1/admin/policies:reload:
post:
operationId: postAdminPoliciesReload
summary: Reload signed policy files from the configured directory
x-required-permission: policy:reload
responses:
'200':
description: Per-type reload outcomes
content:
application/json:
schema: {$ref: '#/components/schemas/PoliciesReloadResponse'}
'403':
description: Caller lacks policy:reload
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/diagnostics:require-remediation-execute:
post:
operationId: postDiagnosticsRequireRemediationExecute
summary: Stage-0 RBAC+license demo; requires remediation:execute (RBAC) + premium_diagnostics (license)
x-required-permission: remediation:execute
x-required-feature: premium_diagnostics
parameters:
- name: Idempotency-Key
in: header
required: true
schema: {type: string, minLength: 1, maxLength: 255}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/EchoRequest'}
responses:
'200':
description: Echoed
content:
application/json:
schema: {$ref: '#/components/schemas/EchoResponse'}
'402':
description: License does not include remediation_execution
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'403':
description: Caller lacks remediation:execute
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/auth/me/permissions:
get:
operationId: getAuthMePermissions
summary: Effective permissions for the calling identity
responses:
'200':
description: Permission list
content:
application/json:
schema: {$ref: '#/components/schemas/AuthMePermissionsResponse'}
/api/v1/auth/permissions:registry:
get:
operationId: getAuthPermissionsRegistry
summary: Full RBAC registry (categories, permissions, built-in roles)
responses:
'200':
description: Registry
content:
application/json:
schema: {$ref: '#/components/schemas/PermissionsRegistryResponse'}
/api/v1/users:
get:
operationId: getUsers
summary: List users
x-required-permission: user:read
responses:
'200':
description: User list
content:
application/json:
schema: {$ref: '#/components/schemas/UsersListResponse'}
'403':
description: Caller lacks user:read
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
post:
operationId: postUsers
summary: Create a user
x-required-permission: user:write
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/UserCreateRequest'}
responses:
'201':
description: User created
content:
application/json:
schema: {$ref: '#/components/schemas/UserResponse'}
'400':
description: Validation or policy failure
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'403':
description: Caller lacks user:write
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/users/{id}:
get:
operationId: getUserByID
summary: Fetch a user
x-required-permission: user:read
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
responses:
'200':
description: User
content:
application/json:
schema: {$ref: '#/components/schemas/UserResponse'}
'404':
description: User not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
delete:
operationId: deleteUserByID
summary: Soft-delete a user
x-required-permission: user:delete
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
responses:
'204':
description: Deleted
'404':
description: User not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/users/{id}/roles:assign:
post:
operationId: postUserRolesAssign
summary: Assign a role to a user
x-required-permission: role:assign
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/UserRoleAssignRequest'}
responses:
'204':
description: Role assigned
'400':
description: Unknown role id
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/users/{id}/roles:unassign:
post:
operationId: postUserRolesUnassign
summary: Remove a role from a user
x-required-permission: role:assign
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/UserRoleAssignRequest'}
responses:
'204':
description: Role removed (idempotent)
/api/v1/users/{id}:reset-password:
post:
operationId: postUserResetPassword
summary: Admin-reset a user's password (own or another's)
description: |
Sets a user's password on administrator authority - no current
password required. The new password runs through the role-aware
policy + breach screen; the target's active sessions are revoked so
they must re-authenticate. RBAC: admin:user_manage. Spec api-users.
x-required-permission: admin:user_manage
x-audit-events: [admin.user.password_reset]
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/UserPasswordResetRequest'}
responses:
'204':
description: Password reset; the target's sessions were revoked
'400':
description: New password rejected by policy (too short/long/breached)
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'403':
description: Caller lacks admin:user_manage permission
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'404':
description: User not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/users/{id}:disable:
post:
operationId: postUserDisable
summary: Disable a user account
description: |
Marks the account disabled: it can no longer authenticate (login is
rejected) and the user's active sessions are revoked immediately. An
admin cannot disable their own account (lockout prevention, 409).
RBAC: admin:user_manage. Spec api-users.
x-required-permission: admin:user_manage
x-audit-events: [admin.user.disabled]
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
responses:
'200':
description: The disabled user
content:
application/json:
schema: {$ref: '#/components/schemas/UserResponse'}
'403':
description: Caller lacks admin:user_manage permission
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'404':
description: User not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'409':
description: Cannot disable your own account
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/users/{id}:enable:
post:
operationId: postUserEnable
summary: Re-enable a disabled user account
description: |
Clears the disabled flag so the user can authenticate again with a
fresh login (sessions revoked while disabled stay dead). RBAC:
admin:user_manage. Spec api-users.
x-required-permission: admin:user_manage
x-audit-events: [admin.user.enabled]
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
responses:
'200':
description: The re-enabled user
content:
application/json:
schema: {$ref: '#/components/schemas/UserResponse'}
'403':
description: Caller lacks admin:user_manage permission
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'404':
description: User not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/roles:create:
post:
operationId: postRolesCreate
summary: Create a custom role
x-required-permission: role:write
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/CustomRoleCreateRequest'}
responses:
'201':
description: Custom role created
content:
application/json:
schema: {$ref: '#/components/schemas/CustomRoleResponse'}
'400':
description: Permission unknown
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'409':
description: Role id taken
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/roles:
get:
operationId: getRoles
summary: List built-in roles
x-required-permission: role:read
responses:
'200':
description: Role list
content:
application/json:
schema: {$ref: '#/components/schemas/AdminRolesResponse'}
'403':
description: Caller lacks role:read
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/credentials:
get:
operationId: getCredentials
summary: List credentials (metadata only)
x-required-permission: credential:read
responses:
'200':
description: Credential metadata list
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialListResponse'}
'403':
description: Caller lacks credential:read
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
post:
operationId: postCredentials
summary: Create a credential
x-required-permission: credential:write
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialCreateRequest'}
responses:
'201':
description: Credential created
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialResponse'}
'400':
description: Validation, invalid scope, host not found, or invalid SSH key
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'409':
description: Multiple system defaults
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/credentials/{id}:
get:
operationId: getCredentialByID
summary: Fetch a credential's metadata
x-required-permission: credential:read
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
responses:
'200':
description: Credential metadata
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialResponse'}
'404':
description: Credential not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
patch:
operationId: patchCredentialByID
summary: Update a credential in place
description: >
Partial update of an existing active credential. Only the fields
present in the body change; omitted fields are left untouched.
Secret material (password, private_key, private_key_passphrase)
is re-encrypted only when a non-empty value is supplied — omitting
a secret keeps the stored ciphertext, so metadata can be edited
without re-entering the key or password. scope and scope_id are
immutable. Setting is_default=true on a system credential atomically
demotes the previous system default.
x-required-permission: credential:write
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialUpdateRequest'}
responses:
'200':
description: Updated credential metadata
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialResponse'}
'400':
description: Validation failure (unknown auth_method, missing required secret)
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'404':
description: Credential not found or already soft-deleted
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'409':
description: is_default=true collides with an existing system default
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
delete:
operationId: deleteCredentialByID
summary: Soft-delete a credential
x-required-permission: credential:delete
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
responses:
'204':
description: Deleted (is_active=false)
'404':
description: Credential not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/credentials/{id}:clone:
post:
operationId: postCredentialClone
summary: Clone a credential into a new scope (system → host or host → host)
description: >
Copies the source credential's encrypted secret material verbatim
into a new row with the target scope/scope_id. Used by the bulk
import flow to attach a chosen credential template to each newly
imported host without re-prompting for the secret material.
x-required-permission: credential:write
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialCloneRequest'}
responses:
'201':
description: Clone created
content:
application/json:
schema: {$ref: '#/components/schemas/CredentialResponse'}
'400':
description: Invalid scope, host not found, or validation failure
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'404':
description: Source credential not found or already soft-deleted
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'409':
description: is_default=true collides with an existing system default
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/hosts:
get:
operationId: getHosts
summary: List hosts
x-required-permission: host:read
parameters:
- {name: environment, in: query, required: false, schema: {type: string}}
- {name: tag, in: query, required: false, schema: {type: string}}
responses:
'200':
description: Host list
content:
application/json:
schema: {$ref: '#/components/schemas/HostListResponse'}
'403':
description: Caller lacks host:read
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
post:
operationId: postHosts
summary: Create a host
x-required-permission: host:write
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/HostCreateRequest'}
responses:
'201':
description: Host created
content:
application/json:
schema: {$ref: '#/components/schemas/HostResponse'}
'400':
description: Validation failure (bad hostname, ip, port, etc.)
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'409':
description: Hostname already exists in environment
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
/api/v1/hosts/{id}:
get:
operationId: getHostByID
summary: Fetch a host with liveness + compliance enrichment
x-required-permission: host:read
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
- name: framework
in: query
description: Filter compliance_summary to host_rule_state rows whose framework_refs contains this key (v1.2.0). Liveness is unaffected.
schema: {type: string}
responses:
'200':
description: Host detail (includes liveness + compliance_summary)
content:
application/json:
schema: {$ref: '#/components/schemas/HostDetailResponse'}
'404':
description: Host not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
patch:
operationId: patchHostByID
summary: Update mutable host fields
x-required-permission: host:write
parameters:
- {name: id, in: path, required: true, schema: {type: string, format: uuid}}
requestBody:
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/HostUpdateRequest'}
responses:
'200':
description: Host updated
content:
application/json:
schema: {$ref: '#/components/schemas/HostResponse'}
'400':
description: Validation failure
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
'404':
description: Host not found
content:
application/json:
schema: {$ref: '#/components/schemas/ErrorEnvelope'}
delete: