@knowttl/checkpoint-axi 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +457 -2
  3. package/axi-credential.schema.json +35 -0
  4. package/bin/checkpoint-axi-hook.js +9 -0
  5. package/bin/checkpoint-axi.js +8 -0
  6. package/bin/version.js +3 -0
  7. package/dist/src/catalogue.d.ts +317 -0
  8. package/dist/src/catalogue.js +103 -0
  9. package/dist/src/cli.d.ts +9 -0
  10. package/dist/src/cli.js +22 -0
  11. package/dist/src/doctor.d.ts +3 -0
  12. package/dist/src/doctor.js +37 -0
  13. package/dist/src/downloads.d.ts +3 -0
  14. package/dist/src/downloads.js +52 -0
  15. package/dist/src/exceptions.d.ts +37 -0
  16. package/dist/src/exceptions.js +81 -0
  17. package/dist/src/local-commands.d.ts +3 -0
  18. package/dist/src/local-commands.js +123 -0
  19. package/dist/src/private-file.d.ts +10 -0
  20. package/dist/src/private-file.js +65 -0
  21. package/dist/src/profiles.d.ts +122 -0
  22. package/dist/src/profiles.js +137 -0
  23. package/dist/src/reads.d.ts +3 -0
  24. package/dist/src/reads.js +169 -0
  25. package/dist/src/redact.d.ts +6 -0
  26. package/dist/src/redact.js +25 -0
  27. package/dist/src/regions.d.ts +9 -0
  28. package/dist/src/regions.js +10 -0
  29. package/dist/src/transport.d.ts +86 -0
  30. package/dist/src/transport.js +306 -0
  31. package/dist/src/write-exceptions.d.ts +4 -0
  32. package/dist/src/write-exceptions.js +97 -0
  33. package/dist/src/write-sectools.d.ts +5 -0
  34. package/dist/src/write-sectools.js +107 -0
  35. package/dist/src/writes.d.ts +30 -0
  36. package/dist/src/writes.js +295 -0
  37. package/docs/commands.md +461 -0
  38. package/inventory/capabilities.json +217 -0
  39. package/inventory/specs.json +12 -0
  40. package/package.json +54 -4
  41. package/skills/checkpoint-axi/SKILL.md +102 -0
@@ -0,0 +1,461 @@
1
+ <!-- Generated by scripts/generate-docs.mjs from src/catalogue.ts. Do not hand-edit. -->
2
+
3
+ # Command reference
4
+
5
+ Inspect Check Point Email Security through compact, guarded AXI commands.
6
+ Email, event, task and exception reads use the regional API; doctor checks authentication and one bounded search, while discovery commands stay local.
7
+ Run each command with `--help` for concise help.
8
+
9
+ ## attachment download
10
+
11
+ Download one attachment to a new private file with profile opt-in, a 50 MiB cap and verified x-av-sha256; scope behavior is unverified (guide pages 133-135)
12
+
13
+ | Flag | Meaning |
14
+ |---|---|
15
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
16
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
17
+ | `--help` | Show concise command help; default false |
18
+ | `--out` | Required absolute new output file; mode 0600, never stdout or overwrite |
19
+ | `--scope` | Optional authorized scope query; default profile scope when configured; live behavior unverified |
20
+
21
+ ```sh
22
+ checkpoint-axi attachment download <entity-id> <attachment-id> --out /absolute/attachment
23
+ checkpoint-axi attachment download <entity-id> <attachment-id> --scope <scope> --out /absolute/attachment
24
+ ```
25
+
26
+ ## attachment download-all
27
+
28
+ Download available attachments as a ZIP to a new private file with opt-in, a 50 MiB cap and mandatory SHA-256 verification; ZIP hash availability and scopes are unverified; HTTP 200 may contain only some attachments (guide pages 135-137)
29
+
30
+ | Flag | Meaning |
31
+ |---|---|
32
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
33
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
34
+ | `--help` | Show concise command help; default false |
35
+ | `--out` | Required absolute new output file; mode 0600, never stdout or overwrite |
36
+ | `--scope` | Optional authorized scope query; default profile scope when configured; live behavior unverified |
37
+
38
+ ```sh
39
+ checkpoint-axi attachment download-all <entity-id> --out /absolute/attachments
40
+ checkpoint-axi attachment download-all <entity-id> --scope <scope> --out /absolute/attachments
41
+ ```
42
+
43
+ ## auth status
44
+
45
+ Validate the selected local profile and secret source without API calls
46
+
47
+ | Flag | Meaning |
48
+ |---|---|
49
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
50
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
51
+ | `--fields` | Comma-separated output fields; default all |
52
+ | `--full` | Show full strings instead of 500-character previews; default false |
53
+ | `--help` | Show concise command help; default false |
54
+
55
+ ```sh
56
+ checkpoint-axi auth status
57
+ checkpoint-axi auth status --profile example
58
+ ```
59
+
60
+ ## config path
61
+
62
+ Show config and state paths without reading files; --profile does not affect paths
63
+
64
+ | Flag | Meaning |
65
+ |---|---|
66
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
67
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
68
+ | `--fields` | Comma-separated output fields; default all |
69
+ | `--full` | Show full strings instead of 500-character previews; default false |
70
+ | `--help` | Show concise command help; default false |
71
+
72
+ ```sh
73
+ checkpoint-axi config path
74
+ checkpoint-axi config path --fields config
75
+ ```
76
+
77
+ ## doctor
78
+
79
+ Check regional API authentication and one bounded email search without printing tenant data
80
+
81
+ | Flag | Meaning |
82
+ |---|---|
83
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
84
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
85
+ | `--fields` | Comma-separated output fields; default all |
86
+ | `--full` | Show full strings instead of 500-character previews; default false |
87
+ | `--help` | Show concise command help; default false |
88
+ | `--saas` | SaaS override; default selected profile saas or office365_emails |
89
+
90
+ ```sh
91
+ checkpoint-axi doctor
92
+ checkpoint-axi doctor --profile example --saas office365_emails
93
+ ```
94
+
95
+ ## email download
96
+
97
+ Download an email to a new private file with profile opt-in, a 50 MiB cap and mandatory SHA-256 verification; scopes and email hash availability are unverified (guide pages 131-132)
98
+
99
+ | Flag | Meaning |
100
+ |---|---|
101
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
102
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
103
+ | `--help` | Show concise command help; default false |
104
+ | `--out` | Required absolute new output file; mode 0600, never stdout or overwrite |
105
+ | `--original` | Download original email without processing modifications; default false |
106
+
107
+ ```sh
108
+ checkpoint-axi email download <entity-id> --out /absolute/message
109
+ checkpoint-axi email download <entity-id> --original --out /absolute/original
110
+ ```
111
+
112
+ ## email quarantine
113
+
114
+ Preview or request asynchronous email quarantine through the gated write coordinator (guide pages 28-30)
115
+
116
+ | Flag | Meaning |
117
+ |---|---|
118
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
119
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
120
+ | `--fields` | Comma-separated output fields; default all |
121
+ | `--full` | Show full strings instead of 500-character previews; default false |
122
+ | `--help` | Show concise command help; default false |
123
+ | `--ids` | Required comma-separated unique entity IDs; maximum 20 |
124
+ | `--execute` | Send once after all write gates; default false (preview) |
125
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
126
+ | `--confirm` | Exact operation followed by a space and the comma-separated IDs in supplied order |
127
+
128
+ ```sh
129
+ checkpoint-axi email quarantine --ids <id>
130
+ checkpoint-axi email quarantine --ids <id> --execute --confirm 'email.quarantine <id>'
131
+ ```
132
+
133
+ ## email restore
134
+
135
+ Preview or request asynchronous email restore through the gated write coordinator (guide pages 28-30)
136
+
137
+ | Flag | Meaning |
138
+ |---|---|
139
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
140
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
141
+ | `--fields` | Comma-separated output fields; default all |
142
+ | `--full` | Show full strings instead of 500-character previews; default false |
143
+ | `--help` | Show concise command help; default false |
144
+ | `--ids` | Required comma-separated unique entity IDs; maximum 20 |
145
+ | `--execute` | Send once after all write gates; default false (preview) |
146
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
147
+ | `--confirm` | Exact operation followed by a space and the comma-separated IDs in supplied order |
148
+
149
+ ```sh
150
+ checkpoint-axi email restore --ids <id>
151
+ checkpoint-axi email restore --ids <id> --execute --confirm 'email.restore <id>'
152
+ ```
153
+
154
+ ## email search
155
+
156
+ Search emails with a bounded date window and scroll continuation (API guide pages 18-27)
157
+
158
+ | Flag | Meaning |
159
+ |---|---|
160
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
161
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
162
+ | `--fields` | Comma-separated output fields; default all |
163
+ | `--full` | Show full strings instead of 500-character previews; default false |
164
+ | `--help` | Show concise command help; default false |
165
+ | `--saas` | SaaS override; default selected profile saas or office365_emails |
166
+ | `--saas-entity` | Optional SaaS entity type selector |
167
+ | `--start-date` | ISO timestamp with timezone; default 24 hours before end-date; maximum window 31 days |
168
+ | `--end-date` | ISO timestamp with timezone; default now |
169
+ | `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
170
+ | `--all` | Read up to 1000 rows / 10 HTTP requests / 60 seconds / 8 MiB; default false |
171
+ | `--cursor` | Opaque continuation bound to profile, region, operation and selectors; repeat original selectors |
172
+ | `--filter` | JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters (guide pages 19-20) |
173
+
174
+ ```sh
175
+ checkpoint-axi email search
176
+ checkpoint-axi email search --all --saas office365_emails
177
+ checkpoint-axi email search --cursor <cursor>
178
+ ```
179
+
180
+ ## email show
181
+
182
+ Show one email with verdicts, actions and available actions (API guide pages 10-18)
183
+
184
+ | Flag | Meaning |
185
+ |---|---|
186
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
187
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
188
+ | `--fields` | Comma-separated output fields; default all |
189
+ | `--full` | Show full strings instead of 500-character previews; default false |
190
+ | `--help` | Show concise command help; default false |
191
+
192
+ ```sh
193
+ checkpoint-axi email show <id>
194
+ checkpoint-axi email show <id> --full
195
+ ```
196
+
197
+ ## event action
198
+
199
+ Preview or request a name-only event action; parameterized actions refuse ENDPOINT_UNVERIFIED pending commissioning (guide pages 35-37, 42-45)
200
+
201
+ | Flag | Meaning |
202
+ |---|---|
203
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
204
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
205
+ | `--fields` | Comma-separated output fields; default all |
206
+ | `--full` | Show full strings instead of 500-character previews; default false |
207
+ | `--help` | Show concise command help; default false |
208
+ | `--ids` | Required comma-separated unique event IDs; maximum 20 |
209
+ | `--execute` | Send once after all write gates; default false (preview) |
210
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
211
+ | `--confirm` | Exact operation followed by a space and the comma-separated IDs in supplied order |
212
+ | `--name` | Required available action name; nonempty action parameters are unverified |
213
+
214
+ ```sh
215
+ checkpoint-axi event action --ids <id> --name dismiss
216
+ checkpoint-axi event action --ids <id> --name dismiss --execute --confirm 'event.action.dismiss <id>'
217
+ ```
218
+
219
+ ## event list
220
+
221
+ List security events with bounded scroll continuation (API guide pages 37-42)
222
+
223
+ | Flag | Meaning |
224
+ |---|---|
225
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
226
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
227
+ | `--fields` | Comma-separated output fields; default all |
228
+ | `--full` | Show full strings instead of 500-character previews; default false |
229
+ | `--help` | Show concise command help; default false |
230
+ | `--start-date` | ISO timestamp with timezone; default 24 hours before end-date; maximum window 31 days |
231
+ | `--end-date` | ISO timestamp with timezone; default now |
232
+ | `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
233
+ | `--all` | Read up to 1000 rows / 10 HTTP requests / 60 seconds / 8 MiB; default false |
234
+ | `--cursor` | Opaque continuation bound to profile, region, operation and selectors; repeat original selectors |
235
+ | `--saas` | Comma-separated SaaS overrides; default selected profile saas or office365_emails |
236
+ | `--event-types` | Comma-separated event types; default unfiltered |
237
+ | `--event-states` | Comma-separated event states; default unfiltered |
238
+ | `--severities` | Comma-separated severities; default unfiltered |
239
+ | `--event-ids` | Comma-separated event IDs; default unfiltered |
240
+ | `--confidence-indicator` | Confidence indicator selector; default unfiltered |
241
+ | `--description` | Description selector; default unfiltered |
242
+
243
+ ```sh
244
+ checkpoint-axi event list
245
+ checkpoint-axi event list --all --event-types phishing
246
+ checkpoint-axi event list --cursor <cursor>
247
+ ```
248
+
249
+ ## event show
250
+
251
+ Show one event, actions taken and available actions (API guide pages 34-37)
252
+
253
+ | Flag | Meaning |
254
+ |---|---|
255
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
256
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
257
+ | `--fields` | Comma-separated output fields; default all |
258
+ | `--full` | Show full strings instead of 500-character previews; default false |
259
+ | `--help` | Show concise command help; default false |
260
+
261
+ ```sh
262
+ checkpoint-axi event show <id>
263
+ checkpoint-axi event show <id> --full
264
+ ```
265
+
266
+ ## exception clear
267
+
268
+ Refuse click-time/malware/url/dlp clear with ENDPOINT_UNVERIFIED until commissioning establishes counts and delete contracts (guide pages 87-88, 96-97, 107-110, 117-120, 128-131)
269
+
270
+ | Flag | Meaning |
271
+ |---|---|
272
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
273
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
274
+ | `--fields` | Comma-separated output fields; default all |
275
+ | `--full` | Show full strings instead of 500-character previews; default false |
276
+ | `--help` | Show concise command help; default false |
277
+ | `--execute` | Send once after all write gates; default false (preview) |
278
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
279
+ | `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
280
+
281
+ ```sh
282
+ checkpoint-axi exception clear click-time
283
+ checkpoint-axi exception clear click-time --dry-run
284
+ ```
285
+
286
+ ## exception create
287
+
288
+ Preview or create one exception of any kind; anomaly/click-time/malware/url/dlp response identities are unverified (guide pages 61-64, 75-78, 84-85, 91-93, 102-105, 113-116, 123-126)
289
+
290
+ | Flag | Meaning |
291
+ |---|---|
292
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
293
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
294
+ | `--fields` | Comma-separated output fields; default all |
295
+ | `--full` | Show full strings instead of 500-character previews; default false |
296
+ | `--help` | Show concise command help; default false |
297
+ | `--execute` | Send once after all write gates; default false (preview) |
298
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
299
+ | `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
300
+ | `--input` | Required absolute private JSON file containing documented requestData fields directly; fields depend on kind; update sends a replacement PUT |
301
+ | `--specific` | Malware/url/dlp only: use the documented create-specific /exceptions route; default false; included in confirmation digest |
302
+
303
+ ```sh
304
+ checkpoint-axi exception create phishing-allow --input /absolute/rule.json
305
+ checkpoint-axi exception create spam-allow --input /absolute/rule.json --execute --confirm 'exception.spam-allow.create sha256:<preview-digest>'
306
+ ```
307
+
308
+ ## exception list
309
+
310
+ List bounded exceptions for phishing-allow, phishing-block, spam-allow, anomaly, click-time, malware, url or dlp (guide pages 49-123)
311
+
312
+ | Flag | Meaning |
313
+ |---|---|
314
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
315
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
316
+ | `--fields` | Comma-separated output fields; default all |
317
+ | `--full` | Show full strings instead of 500-character previews; default false |
318
+ | `--help` | Show concise command help; default false |
319
+ | `--type` | Required for malware: hash,micro_hash,file_type,ppat_sender_name,allow_file_type,sender_email; url: allow-url,allow-domain,block-url,block-domain; dlp: hash,text_content,sender_email,recipient_email |
320
+ | `--items` | Click-time item routes instead of list routes; default false |
321
+ | `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
322
+ | `--all` | Return up to 1000 rows within transport budgets; no server continuation parameter is documented |
323
+
324
+ ```sh
325
+ checkpoint-axi exception list phishing-allow
326
+ checkpoint-axi exception list malware --type hash
327
+ checkpoint-axi exception list click-time --items --all
328
+ ```
329
+
330
+ ## exception remove
331
+
332
+ Preview or remove one phishing/spam/anomaly/click-time exception by ID; malware/url/dlp refuse ENDPOINT_UNVERIFIED before authentication (guide pages 67-69, 81-82, 85-87, 98-99, 108-110, 119-120, 129-131)
333
+
334
+ | Flag | Meaning |
335
+ |---|---|
336
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
337
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
338
+ | `--fields` | Comma-separated output fields; default all |
339
+ | `--full` | Show full strings instead of 500-character previews; default false |
340
+ | `--help` | Show concise command help; default false |
341
+ | `--execute` | Send once after all write gates; default false (preview) |
342
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
343
+ | `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
344
+
345
+ ```sh
346
+ checkpoint-axi exception remove phishing-allow <id>
347
+ checkpoint-axi exception remove spam-allow <id> --execute --confirm 'exception.spam-allow.remove <id>'
348
+ ```
349
+
350
+ ## exception remove-items
351
+
352
+ Preview or remove 1-20 click-time items by caller-supplied IDs; existence is unverified (guide pages 97-98)
353
+
354
+ | Flag | Meaning |
355
+ |---|---|
356
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
357
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
358
+ | `--fields` | Comma-separated output fields; default all |
359
+ | `--full` | Show full strings instead of 500-character previews; default false |
360
+ | `--help` | Show concise command help; default false |
361
+ | `--execute` | Send once after all write gates; default false (preview) |
362
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
363
+ | `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
364
+ | `--ids` | Required 1-20 unique comma-separated click-time item IDs |
365
+
366
+ ```sh
367
+ checkpoint-axi exception remove-items click-time --ids <id1>,<id2>
368
+ checkpoint-axi exception remove-items click-time --ids <id1>,<id2> --execute --confirm 'exception.click-time.remove-items <id1>,<id2>'
369
+ ```
370
+
371
+ ## exception show
372
+
373
+ Show an exception by kind and ID/value; anomaly refuses ENDPOINT_UNVERIFIED pending commissioning (guide pages 52-123)
374
+
375
+ | Flag | Meaning |
376
+ |---|---|
377
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
378
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
379
+ | `--fields` | Comma-separated output fields; default all |
380
+ | `--full` | Show full strings instead of 500-character previews; default false |
381
+ | `--help` | Show concise command help; default false |
382
+ | `--type` | Required for malware: hash,micro_hash,file_type,ppat_sender_name,allow_file_type,sender_email; url: allow-url,allow-domain,block-url,block-domain; dlp: hash,text_content,sender_email,recipient_email |
383
+ | `--items` | Click-time item route instead of list route; default false |
384
+
385
+ ```sh
386
+ checkpoint-axi exception show phishing-block <id>
387
+ checkpoint-axi exception show url <value> --type allow-url
388
+ checkpoint-axi exception show click-time <id> --items --full
389
+ ```
390
+
391
+ ## exception update
392
+
393
+ Preview or replace one exception; phishing/spam/click-time require an ID; malware/url/dlp identify it in --input without an ID; anomaly unsupported (guide pages 64-67, 78-81, 94-96, 105-107, 116-117, 126-127)
394
+
395
+ | Flag | Meaning |
396
+ |---|---|
397
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
398
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
399
+ | `--fields` | Comma-separated output fields; default all |
400
+ | `--full` | Show full strings instead of 500-character previews; default false |
401
+ | `--help` | Show concise command help; default false |
402
+ | `--execute` | Send once after all write gates; default false (preview) |
403
+ | `--dry-run` | Explicit preview; cannot combine with --execute |
404
+ | `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
405
+ | `--input` | Required absolute private JSON file containing documented requestData fields directly; fields depend on kind; update sends a replacement PUT |
406
+
407
+ ```sh
408
+ checkpoint-axi exception update phishing-block <id> --input /absolute/rule.json
409
+ checkpoint-axi exception update spam-allow <id> --input /absolute/rule.json --execute --confirm 'exception.spam-allow.update <id>'
410
+ ```
411
+
412
+ ## home
413
+
414
+ Show local profile context without resolving secrets or making API calls
415
+
416
+ | Flag | Meaning |
417
+ |---|---|
418
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
419
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
420
+ | `--fields` | Comma-separated output fields; default all |
421
+ | `--full` | Show full strings instead of 500-character previews; default false |
422
+ | `--help` | Show concise command help; default false |
423
+
424
+ ```sh
425
+ checkpoint-axi
426
+ checkpoint-axi home --profile example
427
+ ```
428
+
429
+ ## profile list
430
+
431
+ List file profiles without resolving secrets; --profile does not filter this list
432
+
433
+ | Flag | Meaning |
434
+ |---|---|
435
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
436
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
437
+ | `--fields` | Comma-separated output fields; default all |
438
+ | `--full` | Show full strings instead of 500-character previews; default false |
439
+ | `--help` | Show concise command help; default false |
440
+
441
+ ```sh
442
+ checkpoint-axi profile list
443
+ checkpoint-axi profile list --config /example/config.json
444
+ ```
445
+
446
+ ## task show
447
+
448
+ Show asynchronous task status and per-action details (API guide pages 30-33)
449
+
450
+ | Flag | Meaning |
451
+ |---|---|
452
+ | `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
453
+ | `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
454
+ | `--fields` | Comma-separated output fields; default all |
455
+ | `--full` | Show full strings instead of 500-character previews; default false |
456
+ | `--help` | Show concise command help; default false |
457
+
458
+ ```sh
459
+ checkpoint-axi task show <id>
460
+ checkpoint-axi task show <id> --full
461
+ ```
@@ -0,0 +1,217 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "sources": [
4
+ {
5
+ "id": "email-security-api",
6
+ "title": "Email Security API Reference Guide",
7
+ "revision": "2026-10-23",
8
+ "url": "https://sc1.checkpoint.com/documents/Harmony_Email_and_Collaboration_API_Reference/CP_Check_Point_Email_Security_API_Reference_Guide.pdf",
9
+ "sha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
10
+ "bytes": 2596219,
11
+ "pages": 138,
12
+ "redistributed": false
13
+ }
14
+ ],
15
+ "coverage": [
16
+ {
17
+ "capability": "auth exchange and doctor",
18
+ "pages": "8-9",
19
+ "slice": "C2",
20
+ "disposition": "auth",
21
+ "reason": "Shipped in C2; commission the undocumented token contract manually.",
22
+ "source": "email-security-api",
23
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
24
+ "executable": true
25
+ },
26
+ {
27
+ "capability": "email search and show",
28
+ "pages": "10-27",
29
+ "slice": "C3",
30
+ "disposition": "read",
31
+ "reason": "Shipped in C3; GET entity detail and POST search/query with bounded scroll.",
32
+ "source": "email-security-api",
33
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
34
+ "executable": true
35
+ },
36
+ {
37
+ "capability": "event list and show",
38
+ "pages": "34-42",
39
+ "slice": "C4",
40
+ "disposition": "read",
41
+ "reason": "Shipped in C4; GET event detail and POST event/query with bounded scroll.",
42
+ "source": "email-security-api",
43
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
44
+ "executable": true
45
+ },
46
+ {
47
+ "capability": "task show",
48
+ "pages": "30-33",
49
+ "slice": "C4",
50
+ "disposition": "read",
51
+ "reason": "Shipped in C4; GET task status and per-action details for asynchronous actions.",
52
+ "source": "email-security-api",
53
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
54
+ "executable": true
55
+ },
56
+ {
57
+ "capability": "legacy exception reads",
58
+ "pages": "49-55",
59
+ "slice": "C5",
60
+ "disposition": "read",
61
+ "reason": "Shipped in C5 through phishing-allow and phishing-block list/show; same whitelist/blacklist routes.",
62
+ "source": "email-security-api",
63
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
64
+ "executable": true
65
+ },
66
+ {
67
+ "capability": "exception list and show for eight kinds",
68
+ "pages": "55-131",
69
+ "slice": "C5",
70
+ "disposition": "read",
71
+ "reason": "Shipped in C5; documented family/item reads; anomaly show refuses ENDPOINT_UNVERIFIED pending response identity commissioning.",
72
+ "source": "email-security-api",
73
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
74
+ "executable": true
75
+ },
76
+ {
77
+ "capability": "email quarantine and restore",
78
+ "pages": "28-30",
79
+ "slice": "C6",
80
+ "disposition": "write",
81
+ "reason": "Shipped in C6; POST action/entity through the gated coordinator with durable intent, exact confirmation, re-read and no retry.",
82
+ "source": "email-security-api",
83
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
84
+ "executable": true
85
+ },
86
+ {
87
+ "capability": "event action",
88
+ "pages": "42-45",
89
+ "slice": "C7",
90
+ "disposition": "write",
91
+ "reason": "Shipped in C7; gated POST action/event validates availableEventActions; parameterized actions refuse ENDPOINT_UNVERIFIED pending commissioning.",
92
+ "source": "email-security-api",
93
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
94
+ "executable": true
95
+ },
96
+ {
97
+ "capability": "phishing create update remove",
98
+ "pages": "61-69",
99
+ "slice": "C8",
100
+ "disposition": "write",
101
+ "reason": "Shipped in C8; gated allow/block create, PUT replacement and bodyless POST remove with exact scope and confirmation.",
102
+ "source": "email-security-api",
103
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
104
+ "executable": true
105
+ },
106
+ {
107
+ "capability": "spam create update remove",
108
+ "pages": "75-83",
109
+ "slice": "C8",
110
+ "disposition": "write",
111
+ "reason": "Shipped in C8; gated allow-list create, PUT replacement and bodyless POST remove with exact scope and confirmation.",
112
+ "source": "email-security-api",
113
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
114
+ "executable": true
115
+ },
116
+ {
117
+ "capability": "anomaly create remove",
118
+ "pages": "84-87",
119
+ "slice": "C9",
120
+ "disposition": "write",
121
+ "reason": "Shipped in C9; gated shared POST distinguished by documented request bodies; response identities remain unverified.",
122
+ "source": "email-security-api",
123
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
124
+ "executable": true
125
+ },
126
+ {
127
+ "capability": "click-time create update remove remove-items clear",
128
+ "pages": "91-100",
129
+ "slice": "C9",
130
+ "disposition": "write",
131
+ "reason": "Shipped in C9; gated item writes; clear refuses ENDPOINT_UNVERIFIED and collection PUT is deferred until commissioning.",
132
+ "source": "email-security-api",
133
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
134
+ "executable": true
135
+ },
136
+ {
137
+ "capability": "malware create update",
138
+ "pages": "102-106",
139
+ "slice": "C10",
140
+ "disposition": "write",
141
+ "reason": "Shipped in C10; gated create, create-specific and PUT modify checkpoint2; response identities remain unverified.",
142
+ "source": "email-security-api",
143
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
144
+ "executable": true
145
+ },
146
+ {
147
+ "capability": "url create update",
148
+ "pages": "113-117",
149
+ "slice": "C10",
150
+ "disposition": "write",
151
+ "reason": "Shipped in C10; gated create, create-specific and PUT modify avanan_url; response identities remain unverified.",
152
+ "source": "email-security-api",
153
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
154
+ "executable": true
155
+ },
156
+ {
157
+ "capability": "dlp create update",
158
+ "pages": "123-127",
159
+ "slice": "C10",
160
+ "disposition": "write",
161
+ "reason": "Shipped in C10; gated create, create-specific and PUT modify avanan_dlp; response identities remain unverified.",
162
+ "source": "email-security-api",
163
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
164
+ "executable": true
165
+ },
166
+ {
167
+ "capability": "malware remove clear",
168
+ "pages": "107-110",
169
+ "slice": "C10",
170
+ "disposition": "unverified",
171
+ "reason": "Refuse two ambiguous deletes with ENDPOINT_UNVERIFIED pending commissioning.",
172
+ "source": "email-security-api",
173
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
174
+ "executable": false
175
+ },
176
+ {
177
+ "capability": "url remove clear",
178
+ "pages": "117-120",
179
+ "slice": "C10",
180
+ "disposition": "unverified",
181
+ "reason": "Refuse two ambiguous deletes with ENDPOINT_UNVERIFIED pending commissioning.",
182
+ "source": "email-security-api",
183
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
184
+ "executable": false
185
+ },
186
+ {
187
+ "capability": "dlp remove clear",
188
+ "pages": "128-131",
189
+ "slice": "C10",
190
+ "disposition": "unverified",
191
+ "reason": "Refuse two ambiguous deletes with ENDPOINT_UNVERIFIED pending commissioning.",
192
+ "source": "email-security-api",
193
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
194
+ "executable": false
195
+ },
196
+ {
197
+ "capability": "email and attachment downloads",
198
+ "pages": "131-137",
199
+ "slice": "C11",
200
+ "disposition": "download",
201
+ "reason": "Shipped in C11; opt-in private files, 50 MiB cap and mandatory SHA-256; scopes and email/ZIP hash availability remain unverified.",
202
+ "source": "email-security-api",
203
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
204
+ "executable": true
205
+ },
206
+ {
207
+ "capability": "audit logs",
208
+ "pages": "138",
209
+ "slice": "C12",
210
+ "disposition": "excluded",
211
+ "reason": "Outside this API; use Check Point Portal APIs separately.",
212
+ "source": "email-security-api",
213
+ "sourceSha256": "77d99a258462f13890743811aaaae797843a3d1890bf5726b0b008f0296f5825",
214
+ "executable": false
215
+ }
216
+ ]
217
+ }