-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
5228 lines (5224 loc) · 326 KB
/
index.html
File metadata and controls
5228 lines (5224 loc) · 326 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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Evydence API - Rendered OpenAPI Docs</title>
<style>
:root {
color-scheme: light;
--bg: #f7f5ef;
--ink: #0f1411;
--muted: #51615b;
--line: #d7d2c5;
--panel: #fffdf7;
--accent: #006d5b;
--accent-soft: #d7eee8;
}
* { box-sizing: border-box; }
body {
margin: 0;
background: var(--bg);
color: var(--ink);
font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
line-height: 1.55;
}
header {
border-bottom: 1px solid var(--line);
padding: 40px clamp(20px, 5vw, 64px);
}
main {
max-width: 1180px;
margin: 0 auto;
padding: 28px clamp(16px, 4vw, 40px) 60px;
}
h1 {
margin: 0 0 12px;
font-size: clamp(2rem, 4vw, 4rem);
line-height: 1;
}
h2 { margin: 36px 0 16px; font-size: 1.5rem; }
h3 { margin: 14px 0 8px; font-size: 1.1rem; }
p { max-width: 76ch; color: var(--muted); }
a { color: var(--accent); }
code {
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, "Liberation Mono", monospace;
font-size: 0.95em;
overflow-wrap: anywhere;
}
.summary-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(180px, 1fr));
gap: 12px;
margin-top: 24px;
}
.summary-card, .operation, .schema-table {
background: var(--panel);
border: 1px solid var(--line);
border-radius: 8px;
}
.summary-card { padding: 16px; }
.summary-card strong { display: block; font-size: 1.6rem; }
.controls {
display: grid;
gap: 8px;
margin: 24px 0;
}
input[type="search"] {
width: 100%;
border: 1px solid var(--line);
border-radius: 8px;
padding: 14px 16px;
font: inherit;
background: white;
}
.operations {
display: grid;
gap: 14px;
}
.operation { padding: 18px; }
.operation[hidden] { display: none; }
.operation-heading {
display: flex;
align-items: center;
gap: 10px;
flex-wrap: wrap;
}
.method {
display: inline-flex;
min-width: 64px;
justify-content: center;
border-radius: 999px;
padding: 4px 10px;
background: var(--accent-soft);
color: #003f35;
font-weight: 700;
font-size: 0.8rem;
letter-spacing: 0;
}
.method-post { background: #e7ecff; color: #23347b; }
.method-get { background: #d7eee8; color: #005345; }
.method-delete { background: #ffe6df; color: #80311e; }
.method-patch, .method-put { background: #fff0c2; color: #654600; }
dl {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(240px, 1fr));
gap: 10px 18px;
margin: 16px 0 0;
}
dt {
color: var(--muted);
font-size: 0.78rem;
font-weight: 700;
text-transform: uppercase;
}
dd { margin: 2px 0 0; overflow-wrap: anywhere; }
table {
width: 100%;
border-collapse: collapse;
}
th, td {
border-top: 1px solid var(--line);
padding: 10px 12px;
text-align: left;
vertical-align: top;
}
th { color: var(--muted); font-size: 0.82rem; text-transform: uppercase; }
.schema-table {
overflow-x: auto;
}
.notice {
border-left: 4px solid var(--accent);
padding: 12px 16px;
background: var(--panel);
}
</style>
</head>
<body>
<header>
<h1>Evydence API</h1>
<p>Self-hosted API evidence and compliance-readiness ledger.</p>
<p>This page is generated from <code>openapi.yaml</code>. It is a human-readable companion to the committed contract and does not replace route-contract tests.</p>
<div class="summary-grid">
<div class="summary-card"><strong>3.1.0</strong><span>OpenAPI version</span></div>
<div class="summary-card"><strong>169</strong><span>registered paths</span></div>
<div class="summary-card"><strong>186</strong><span>operations</span></div>
<div class="summary-card"><strong>375</strong><span>schemas</span></div>
</div>
</header>
<main>
<section class="notice" aria-label="Security and limitation note">
<p>Runtime secrets, tenant data, raw evidence payloads, private keys, bearer tokens, and customer package contents are not embedded in this generated page. Admin-scoped routes appear only when they are part of the committed public contract.</p>
<p>Error responses use RFC 9457-style Problem Details. The registered <code>Problem</code> schema currently requires: none.</p>
</section>
<section>
<h2>Operations</h2>
<div class="controls">
<label for="operation-search">Filter operations</label>
<input id="operation-search" type="search" autocomplete="off" placeholder="Search by method, path, summary, tag, or scope" />
</div>
<div class="operations" id="operations">
<article class="operation" data-operation data-search="get /v1/admin/instance instance admin snapshot returns instance-level diagnostic counts. requires the explicit instance:admin scope; tenant admin and ordinary wildcard tenant keys are insufficient. instanceadminsnapshot evydence instance:admin">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/admin/instance</code>
</div>
<h3>Instance admin snapshot</h3>
<p>Returns instance-level diagnostic counts. Requires the explicit instance:admin scope; tenant admin and ordinary wildcard tenant keys are insufficient.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>instanceAdminSnapshot</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>instance:admin</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: InstanceAdminSnapshotEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/api-keys list api keys lists tenant-scoped api key metadata without key hashes or one-time secrets. listapikeys evydence admin">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/api-keys</code>
</div>
<h3>List API keys</h3>
<p>Lists tenant-scoped API key metadata without key hashes or one-time secrets.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listAPIKeys</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>admin</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: APIKeyListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/api-keys create api key creates a tenant-scoped api key and returns the secret exactly once. stored records expose only non-secret key metadata. createapikey evydence admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/api-keys</code>
</div>
<h3>Create API key</h3>
<p>Creates a tenant-scoped API key and returns the secret exactly once. Stored records expose only non-secret key metadata.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createAPIKey</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateAPIKeyRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: APIKeyCreateEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/api-security-scans upload api security scan uploads sast, dast, secret, license, or api security scan metadata and raw json payload evidence without exposing raw payload bytes in responses. uploadapisecurityscan evydence security:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/api-security-scans</code>
</div>
<h3>Upload API security scan</h3>
<p>Uploads SAST, DAST, secret, license, or API security scan metadata and raw JSON payload evidence without exposing raw payload bytes in responses.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>uploadAPISecurityScan</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>security:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: UploadSecurityScanRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: SecurityScanEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/approvals create approval record creates an immutable approval record for a release, waiver, package, or review subject. createapproval evydence release:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/approvals</code>
</div>
<h3>Create approval record</h3>
<p>Creates an immutable approval record for a release, waiver, package, or review subject.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createApproval</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>release:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateApprovalRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ApprovalRecordEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/artifact-signatures create artifact signature records detached artifact signature evidence and optional raw signature payload metadata. createartifactsignature evydence evidence:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/artifact-signatures</code>
</div>
<h3>Create artifact signature</h3>
<p>Records detached artifact signature evidence and optional raw signature payload metadata.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createArtifactSignature</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>evidence:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateArtifactSignatureRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ArtifactSignatureEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/artifact-signatures/{id} get artifact signature returns tenant-scoped artifact signature metadata by id. getartifactsignature evydence evidence:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/artifact-signatures/{id}</code>
</div>
<h3>Get artifact signature</h3>
<p>Returns tenant-scoped artifact signature metadata by id.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>getArtifactSignature</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>evidence:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: ArtifactSignatureEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/artifact-signatures/{id}/verify-cosign verify cosign-style artifact signature records deterministic cosign-style verification metadata for an artifact signature without implying online transparency trust. verifycosignsignature evydence verify:read">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/artifact-signatures/{id}/verify-cosign</code>
</div>
<h3>Verify cosign-style artifact signature</h3>
<p>Records deterministic cosign-style verification metadata for an artifact signature without implying online transparency trust.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>verifyCosignSignature</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>verify:read</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: VerifyCosignSignatureRequest</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CosignVerificationEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/artifacts register artifact registers an artifact digest for release evidence and later build/attestation matching. registerartifact evydence evidence:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/artifacts</code>
</div>
<h3>Register artifact</h3>
<p>Registers an artifact digest for release evidence and later build/attestation matching.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>registerArtifact</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>evidence:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: RegisterArtifactRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ArtifactEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/artifacts/{id} get artifact returns a tenant-scoped artifact by id. getartifact evydence evidence:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/artifacts/{id}</code>
</div>
<h3>Get artifact</h3>
<p>Returns a tenant-scoped artifact by id.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>getArtifact</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>evidence:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: ArtifactEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/audit-chain/verify verify audit chain verifies the tenant audit chain continuity and returns deterministic verification checks. verifyauditchain evydence verify:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/audit-chain/verify</code>
</div>
<h3>Verify audit chain</h3>
<p>Verifies the tenant audit chain continuity and returns deterministic verification checks.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>verifyAuditChain</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>verify:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: VerificationResultEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/audit-log list tenant audit log lists tenant-scoped append-only audit-chain entries in reverse chronological order. listauditlog evydence admin">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/audit-log</code>
</div>
<h3>List tenant audit log</h3>
<p>Lists tenant-scoped append-only audit-chain entries in reverse chronological order.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listAuditLog</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>admin</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: AuditChainEntryListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/backup-manifests generate backup manifest generates a tenant-scoped backup manifest after an operator backup completes. the manifest excludes raw payload bytes and private key material. generatebackupmanifest evydence admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/backup-manifests</code>
</div>
<h3>Generate backup manifest</h3>
<p>Generates a tenant-scoped backup manifest after an operator backup completes. The manifest excludes raw payload bytes and private key material.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>generateBackupManifest</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: EmptyObject</dd></div>
<div><dt>Responses</dt><dd>201 application/json: BackupManifestEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/backup-manifests/{id}/verify verify backup manifest verifies a tenant-scoped backup manifest and returns deterministic manifest verification checks. verifybackupmanifest evydence verify:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/backup-manifests/{id}/verify</code>
</div>
<h3>Verify backup manifest</h3>
<p>Verifies a tenant-scoped backup manifest and returns deterministic manifest verification checks.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>verifyBackupManifest</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>verify:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: VerificationResultEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/build-attestations/{id}/verify-signature verify build attestation signature verifies a build attestation signature against configured tenant dsse trust roots. verifybuildattestationsignature evydence verify:read">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/build-attestations/{id}/verify-signature</code>
</div>
<h3>Verify build attestation signature</h3>
<p>Verifies a build attestation signature against configured tenant DSSE trust roots.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>verifyBuildAttestationSignature</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>verify:read</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: EmptyObject</dd></div>
<div><dt>Responses</dt><dd>200 application/json: VerificationResultEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/builds create build run records an immutable ci build run. collector identity is derived from the authenticated key when present. createbuild evydence build:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/builds</code>
</div>
<h3>Create build run</h3>
<p>Records an immutable CI build run. Collector identity is derived from the authenticated key when present.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createBuild</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>build:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateBuildRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: BuildRunEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/builds/{id} get build run returns a tenant-scoped build run by id. getbuild evydence build:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/builds/{id}</code>
</div>
<h3>Get build run</h3>
<p>Returns a tenant-scoped build run by id.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>getBuild</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>build:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: BuildRunEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/builds/{id}/attestations upload build attestation uploads a dsse/in-toto build attestation for a tenant-scoped build and stores raw bytes in object storage. uploadbuildattestation evydence build:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/builds/{id}/attestations</code>
</div>
<h3>Upload build attestation</h3>
<p>Uploads a DSSE/in-toto build attestation for a tenant-scoped build and stores raw bytes in object storage.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>uploadBuildAttestation</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>build:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: DSSEEnvelope</dd></div>
<div><dt>Responses</dt><dd>201 application/json: BuildAttestationEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/collectors list collectors lists tenant-scoped collector metadata without api key hashes or one-time secrets. listcollectors evydence collector:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/collectors</code>
</div>
<h3>List collectors</h3>
<p>Lists tenant-scoped collector metadata without API key hashes or one-time secrets.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listCollectors</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>collector:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CollectorListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/collectors create collector creates a tenant-scoped collector identity, binds a scoped api key, and returns the collector key secret exactly once. createcollector evydence collector:admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/collectors</code>
</div>
<h3>Create collector</h3>
<p>Creates a tenant-scoped collector identity, binds a scoped API key, and returns the collector key secret exactly once.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createCollector</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>collector:admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateCollectorRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CollectorCreateEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/collectors/github/source-snapshots upload github source snapshot uploads a strict github source snapshot, hashes commit messages, and stores repository, commit, branch, and pull-request evidence records. uploadgithubsourcesnapshot evydence source:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/collectors/github/source-snapshots</code>
</div>
<h3>Upload GitHub source snapshot</h3>
<p>Uploads a strict GitHub source snapshot, hashes commit messages, and stores repository, commit, branch, and pull-request evidence records.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>uploadGitHubSourceSnapshot</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>source:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: SourceSnapshotRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: SourceSnapshotEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/collectors/gitlab/source-snapshots upload gitlab source snapshot uploads a strict gitlab source snapshot, hashes commit messages, and stores repository, commit, branch, and pull-request evidence records. uploadgitlabsourcesnapshot evydence source:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/collectors/gitlab/source-snapshots</code>
</div>
<h3>Upload GitLab source snapshot</h3>
<p>Uploads a strict GitLab source snapshot, hashes commit messages, and stores repository, commit, branch, and pull-request evidence records.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>uploadGitLabSourceSnapshot</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>source:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: SourceSnapshotRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: SourceSnapshotEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/collectors/{id}/health collector health report returns collector supply-chain health from recorded tenant evidence, assumptions, and limitations. collectorhealthreport evydence collector:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/collectors/{id}/health</code>
</div>
<h3>Collector health report</h3>
<p>Returns collector supply-chain health from recorded tenant evidence, assumptions, and limitations.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>collectorHealthReport</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>collector:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CollectorHealthReportEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/collectors/{id}/releases record collector release evidence records collector release supply-chain evidence for a tenant-scoped collector. recordcollectorrelease evydence collector:admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/collectors/{id}/releases</code>
</div>
<h3>Record collector release evidence</h3>
<p>Records collector release supply-chain evidence for a tenant-scoped collector.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>recordCollectorRelease</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>collector:admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: RecordCollectorReleaseRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CollectorReleaseEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/commercial-collectors list commercial collector definitions lists tenant-scoped commercial collector definitions. listcommercialcollectors evydence collector:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/commercial-collectors</code>
</div>
<h3>List commercial collector definitions</h3>
<p>Lists tenant-scoped commercial collector definitions.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listCommercialCollectors</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>collector:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CommercialCollectorDefinitionListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/commercial-collectors create commercial collector definition creates tenant-scoped commercial collector metadata without installing external code. createcommercialcollector evydence collector:admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/commercial-collectors</code>
</div>
<h3>Create commercial collector definition</h3>
<p>Creates tenant-scoped commercial collector metadata without installing external code.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createCommercialCollector</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>collector:admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateCommercialCollectorRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CommercialCollectorDefinitionEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/container-images register container image registers oci/container image metadata and digest evidence linked to an optional artifact. registercontainerimage evydence evidence:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/container-images</code>
</div>
<h3>Register container image</h3>
<p>Registers OCI/container image metadata and digest evidence linked to an optional artifact.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>registerContainerImage</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>evidence:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: RegisterContainerImageRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ContainerImageEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/control-evidence list control evidence lists tenant-scoped control evidence links with optional control, product, and release filters. listcontrolevidence evydence controls:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/control-evidence</code>
</div>
<h3>List control evidence</h3>
<p>Lists tenant-scoped control evidence links with optional control, product, and release filters.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listControlEvidence</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: ControlEvidenceListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/control-framework-template-packs list control framework template packs lists built-in control framework template packs available for explicit tenant installation. listcontrolframeworktemplatepacks evydence controls:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/control-framework-template-packs</code>
</div>
<h3>List control framework template packs</h3>
<p>Lists built-in control framework template packs available for explicit tenant installation.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listControlFrameworkTemplatePacks</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: ControlFrameworkTemplatePackListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/control-framework-template-packs/{slug}/install install control framework template pack installs a named control framework template pack into the tenant as ordinary framework/control records. installcontrolframeworktemplatepack evydence controls:admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/control-framework-template-packs/{slug}/install</code>
</div>
<h3>Install control framework template pack</h3>
<p>Installs a named control framework template pack into the tenant as ordinary framework/control records.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>installControlFrameworkTemplatePack</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: EmptyObject</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ControlFrameworkEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/control-frameworks list control frameworks lists tenant-scoped control frameworks. listcontrolframeworks evydence controls:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/control-frameworks</code>
</div>
<h3>List control frameworks</h3>
<p>Lists tenant-scoped control frameworks.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listControlFrameworks</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: ControlFrameworkListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/control-frameworks create control framework creates a tenant-scoped versioned control framework. createcontrolframework evydence controls:admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/control-frameworks</code>
</div>
<h3>Create control framework</h3>
<p>Creates a tenant-scoped versioned control framework.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createControlFramework</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateControlFrameworkRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ControlFrameworkEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/controls create security control creates a framework-owned security control with deterministic evidence requirements. createsecuritycontrol evydence controls:admin">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/controls</code>
</div>
<h3>Create security control</h3>
<p>Creates a framework-owned security control with deterministic evidence requirements.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createSecurityControl</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:admin</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateSecurityControlRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: SecurityControlEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/controls/{id} get security control returns a tenant-scoped security control by id. getsecuritycontrol evydence controls:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/controls/{id}</code>
</div>
<h3>Get security control</h3>
<p>Returns a tenant-scoped security control by id.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>getSecurityControl</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: SecurityControlEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/controls/{id}/evidence link control evidence creates an append-only link between a security control and tenant-scoped evidence or related release resource. linkcontrolevidence evydence controls:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/controls/{id}/evidence</code>
</div>
<h3>Link control evidence</h3>
<p>Creates an append-only link between a security control and tenant-scoped evidence or related release resource.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>linkControlEvidence</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>controls:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: LinkControlEvidenceRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: ControlEvidenceEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/custom-policies create custom policy creates a deterministic custom policy definition for tenant-managed release checks. createcustompolicy evydence policy:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/custom-policies</code>
</div>
<h3>Create custom policy</h3>
<p>Creates a deterministic custom policy definition for tenant-managed release checks.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createCustomPolicy</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>policy:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateCustomPolicyRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CustomPolicyEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/custom-policies/{id}/evaluate evaluate custom policy evaluates a tenant custom policy against a release and records the input hash. evaluatecustompolicy evydence policy:read">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/custom-policies/{id}/evaluate</code>
</div>
<h3>Evaluate custom policy</h3>
<p>Evaluates a tenant custom policy against a release and records the input hash.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>evaluateCustomPolicy</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>policy:read</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: EvaluatePolicyRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CustomPolicyEvaluationEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-packages create customer security package creates a scoped customer security package manifest using an explicit redaction profile. createcustomerpackage evydence package:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-packages</code>
</div>
<h3>Create customer security package</h3>
<p>Creates a scoped customer security package manifest using an explicit redaction profile.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createCustomerPackage</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>package:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateCustomerPackageRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CustomerSecurityPackageEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/customer-packages/{id} get customer security package returns a tenant-scoped customer security package manifest by id. getcustomerpackage evydence package:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/customer-packages/{id}</code>
</div>
<h3>Get customer security package</h3>
<p>Returns a tenant-scoped customer security package manifest by id.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>getCustomerPackage</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>package:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CustomerSecurityPackageEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/customer-packages/{id}/download download customer security package zip downloads a scoped customer security package zip. the archive contains redacted manifest metadata and verification guidance, not raw tenant evidence payload bytes. downloadcustomerpackage evydence package:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/customer-packages/{id}/download</code>
</div>
<h3>Download customer security package ZIP</h3>
<p>Downloads a scoped customer security package ZIP. The archive contains redacted manifest metadata and verification guidance, not raw tenant evidence payload bytes.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>downloadCustomerPackage</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>package:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/zip: string; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/customer-portal/access list customer portal access records lists tenant-scoped external reviewer access records without token hashes or token secrets. listcustomerportalaccess evydence package:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/customer-portal/access</code>
</div>
<h3>List customer portal access records</h3>
<p>Lists tenant-scoped external reviewer access records without token hashes or token secrets.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listCustomerPortalAccess</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>package:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CustomerPortalAccessListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-portal/access create customer portal access creates a named, expiring external reviewer access record for a customer package and returns the portal token once. createcustomerportalaccess evydence package:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-portal/access</code>
</div>
<h3>Create customer portal access</h3>
<p>Creates a named, expiring external reviewer access record for a customer package and returns the portal token once.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>createCustomerPortalAccess</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>package:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CreateCustomerPortalAccessRequest</dd></div>
<div><dt>Responses</dt><dd>201 application/json: CustomerPortalAccessCreateEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-portal/access/{id}/revoke revoke customer portal access revokes a tenant-scoped external reviewer access record; revocation is append-only and the original token cannot be used afterwards. revokecustomerportalaccess evydence package:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-portal/access/{id}/revoke</code>
</div>
<h3>Revoke customer portal access</h3>
<p>Revokes a tenant-scoped external reviewer access record; revocation is append-only and the original token cannot be used afterwards.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>revokeCustomerPortalAccess</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>package:write</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: EmptyObject</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CustomerPortalAccessEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-portal/package access customer portal package public token exchange endpoint for a scoped customer package. it intentionally uses no bearer authentication and accepts only the issued portal token in the json body. accesscustomerportalpackage evydence none">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-portal/package</code>
</div>
<h3>Access customer portal package</h3>
<p>Public token exchange endpoint for a scoped customer package. It intentionally uses no bearer authentication and accepts only the issued portal token in the JSON body.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>accessCustomerPortalPackage</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>none</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CustomerPortalPackageRequest</dd></div>
<div><dt>Responses</dt><dd>200 application/json: CustomerSecurityPackageEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-portal/package/download download customer portal package zip public token exchange endpoint for downloading a scoped customer package zip. it intentionally uses no bearer authentication and accepts only the issued portal token in the json body. downloadcustomerportalpackage evydence none">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-portal/package/download</code>
</div>
<h3>Download customer portal package ZIP</h3>
<p>Public token exchange endpoint for downloading a scoped customer package ZIP. It intentionally uses no bearer authentication and accepts only the issued portal token in the JSON body.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>downloadCustomerPortalPackage</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>none</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/json: CustomerPortalPackageRequest</dd></div>
<div><dt>Responses</dt><dd>200 application/zip: string; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/customer-portal/package/view customer portal package review form public html form for reviewing or downloading a scoped customer package with a portal token. it does not accept tokens in urls and does not use bearer authentication. customerportalpackageviewform evydence none">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/customer-portal/package/view</code>
</div>
<h3>Customer portal package review form</h3>
<p>Public HTML form for reviewing or downloading a scoped customer package with a portal token. It does not accept tokens in URLs and does not use bearer authentication.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>customerPortalPackageViewForm</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>none</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 text/html: string; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-portal/package/view customer portal package review page public html package review endpoint backed by the customer portal token exchange. tokens are accepted only as form body fields. customerportalpackageview evydence none">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-portal/package/view</code>
</div>
<h3>Customer portal package review page</h3>
<p>Public HTML package review endpoint backed by the customer portal token exchange. Tokens are accepted only as form body fields.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>customerPortalPackageView</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>none</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/x-www-form-urlencoded: CustomerPortalPackageRequest</dd></div>
<div><dt>Responses</dt><dd>200 text/html: string; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/customer-portal/package/view/download download customer portal package zip from review form public html-form package zip download endpoint backed by the customer portal token exchange. tokens are accepted only as form body fields. downloadcustomerportalpackageview evydence none">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/customer-portal/package/view/download</code>
</div>
<h3>Download customer portal package ZIP from review form</h3>
<p>Public HTML-form package ZIP download endpoint backed by the customer portal token exchange. Tokens are accepted only as form body fields.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>downloadCustomerPortalPackageView</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>none</dd></div>
<div><dt>Idempotency</dt><dd>Idempotency-Key</dd></div>
<div><dt>Request</dt><dd>application/x-www-form-urlencoded: CustomerPortalPackageRequest</dd></div>
<div><dt>Responses</dt><dd>200 application/zip: string; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="get /v1/deployments list deployments lists tenant-scoped deployment events by optional release and environment filters. listdeployments evydence deployment:read">
<div class="operation-heading">
<span class="method method-get">GET</span>
<code>/v1/deployments</code>
</div>
<h3>List deployments</h3>
<p>Lists tenant-scoped deployment events by optional release and environment filters.</p>
<dl>
<div><dt>Operation ID</dt><dd><code>listDeployments</code></dd></div>
<div><dt>Tags</dt><dd>evydence</dd></div>
<div><dt>Auth</dt><dd>BearerAuth</dd></div>
<div><dt>Scopes</dt><dd>deployment:read</dd></div>
<div><dt>Idempotency</dt><dd>not required</dd></div>
<div><dt>Request</dt><dd>none</dd></div>
<div><dt>Responses</dt><dd>200 application/json: DeploymentEventListEnvelope; 400 application/problem+json: Problem; 401 application/problem+json: Problem; 403 application/problem+json: Problem; 404 application/problem+json: Problem; 409 application/problem+json: Problem; 422 application/problem+json: Problem</dd></div>
</dl>
</article>
<article class="operation" data-operation data-search="post /v1/deployments record deployment records append-only deployment evidence for a release/environment/artifact set. recorddeployment evydence deployment:write">
<div class="operation-heading">
<span class="method method-post">POST</span>
<code>/v1/deployments</code>
</div>