sentry 0.34.0 → 0.36.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.
- package/README.md +19 -13
- package/dist/bin.cjs +1 -1
- package/dist/index.cjs +1912 -1037
- package/dist/index.d.cts +467 -22
- package/dist/ink-app.js +205 -81
- package/package.json +54 -39
package/dist/index.d.cts
CHANGED
|
@@ -35,7 +35,7 @@ export declare function createSentrySDK(options?: SentryOptions): SentrySDK & {
|
|
|
35
35
|
export default createSentrySDK;
|
|
36
36
|
|
|
37
37
|
// Auto-generated by script/generate-sdk.ts — DO NOT EDIT
|
|
38
|
-
// Run `
|
|
38
|
+
// Run `pnpm run generate:sdk` to regenerate.
|
|
39
39
|
|
|
40
40
|
// --- Return types (derived from __jsonSchema) ---
|
|
41
41
|
|
|
@@ -225,15 +225,15 @@ export type IssueListResult = {
|
|
|
225
225
|
/** Issue title */
|
|
226
226
|
title: string;
|
|
227
227
|
/** Culprit string */
|
|
228
|
-
culprit?: string;
|
|
228
|
+
culprit?: string | null;
|
|
229
229
|
/** Total event count */
|
|
230
230
|
count?: string;
|
|
231
231
|
/** Number of affected users */
|
|
232
232
|
userCount?: number;
|
|
233
233
|
/** First occurrence (ISO 8601) */
|
|
234
|
-
firstSeen?: string;
|
|
234
|
+
firstSeen?: string | null;
|
|
235
235
|
/** Most recent occurrence (ISO 8601) */
|
|
236
|
-
lastSeen?: string;
|
|
236
|
+
lastSeen?: string | null;
|
|
237
237
|
/** Severity level */
|
|
238
238
|
level?: string;
|
|
239
239
|
/** Issue status */
|
|
@@ -291,6 +291,55 @@ export type IssueEventsResult = {
|
|
|
291
291
|
metadata?: Record<string, unknown> | null;
|
|
292
292
|
};
|
|
293
293
|
|
|
294
|
+
export type IssueViewResult = {
|
|
295
|
+
/** Numeric issue ID */
|
|
296
|
+
id: string;
|
|
297
|
+
/** Human-readable short ID (e.g. PROJ-ABC) */
|
|
298
|
+
shortId: string;
|
|
299
|
+
/** Issue title */
|
|
300
|
+
title: string;
|
|
301
|
+
/** Culprit string */
|
|
302
|
+
culprit?: string | null;
|
|
303
|
+
/** Total event count */
|
|
304
|
+
count?: string;
|
|
305
|
+
/** Number of affected users */
|
|
306
|
+
userCount?: number;
|
|
307
|
+
/** First occurrence (ISO 8601) */
|
|
308
|
+
firstSeen?: string | null;
|
|
309
|
+
/** Most recent occurrence (ISO 8601) */
|
|
310
|
+
lastSeen?: string | null;
|
|
311
|
+
/** Severity level */
|
|
312
|
+
level?: string;
|
|
313
|
+
/** Issue status */
|
|
314
|
+
status?: string;
|
|
315
|
+
/** URL to the issue in Sentry */
|
|
316
|
+
permalink?: string;
|
|
317
|
+
/** Project info */
|
|
318
|
+
project?: Record<string, unknown>;
|
|
319
|
+
/** Issue metadata */
|
|
320
|
+
metadata?: Record<string, unknown>;
|
|
321
|
+
/** Assigned user or team */
|
|
322
|
+
assignedTo?: Record<string, unknown> | null;
|
|
323
|
+
/** Triage priority */
|
|
324
|
+
priority?: string;
|
|
325
|
+
/** Platform */
|
|
326
|
+
platform?: string;
|
|
327
|
+
/** Issue substatus */
|
|
328
|
+
substatus?: string | null;
|
|
329
|
+
/** Whether the issue is unhandled */
|
|
330
|
+
isUnhandled?: boolean;
|
|
331
|
+
/** Seer AI fixability score (0-1) */
|
|
332
|
+
seerFixabilityScore?: number | null;
|
|
333
|
+
/** Latest event for the issue (full detail) */
|
|
334
|
+
event?: unknown | null;
|
|
335
|
+
/** Organization slug */
|
|
336
|
+
org?: string | null;
|
|
337
|
+
/** Related Session Replay IDs */
|
|
338
|
+
replayIds?: unknown[];
|
|
339
|
+
/** Trace context from the latest event's span tree */
|
|
340
|
+
trace?: Record<string, unknown> | null;
|
|
341
|
+
};
|
|
342
|
+
|
|
294
343
|
export type EventListResult = {
|
|
295
344
|
/** Internal event ID */
|
|
296
345
|
id: string;
|
|
@@ -339,6 +388,25 @@ export type LogListResult = {
|
|
|
339
388
|
trace?: string | null;
|
|
340
389
|
};
|
|
341
390
|
|
|
391
|
+
export type MonitorListResult = {
|
|
392
|
+
/** Monitor ID */
|
|
393
|
+
id: string;
|
|
394
|
+
/** Monitor slug */
|
|
395
|
+
slug: string;
|
|
396
|
+
/** Monitor name */
|
|
397
|
+
name: string;
|
|
398
|
+
/** Monitor status (e.g. active, disabled) */
|
|
399
|
+
status: string;
|
|
400
|
+
/** Whether the monitor is muted */
|
|
401
|
+
isMuted?: boolean;
|
|
402
|
+
/** Schedule configuration */
|
|
403
|
+
config?: Record<string, unknown>;
|
|
404
|
+
/** Creation date (ISO 8601) */
|
|
405
|
+
dateCreated?: string;
|
|
406
|
+
/** Owning project */
|
|
407
|
+
project?: Record<string, unknown>;
|
|
408
|
+
};
|
|
409
|
+
|
|
342
410
|
export type SpanListResult = {
|
|
343
411
|
/** Span ID */
|
|
344
412
|
id: string;
|
|
@@ -392,6 +460,160 @@ export type TrialListResult = {
|
|
|
392
460
|
|
|
393
461
|
// --- Parameter types ---
|
|
394
462
|
|
|
463
|
+
export type AlertIssuesListParams = {
|
|
464
|
+
/** Positional argument */
|
|
465
|
+
orgProject?: string;
|
|
466
|
+
/** Maximum number of issue alert rules to list */
|
|
467
|
+
limit?: number;
|
|
468
|
+
/** Filter rules by name */
|
|
469
|
+
query?: string;
|
|
470
|
+
/** Pagination cursor (use "next" for next page, "prev" for previous) */
|
|
471
|
+
cursor?: string;
|
|
472
|
+
};
|
|
473
|
+
|
|
474
|
+
export type AlertIssuesViewParams = {
|
|
475
|
+
/** Positional argument */
|
|
476
|
+
orgProjectRuleIdOrName?: string;
|
|
477
|
+
};
|
|
478
|
+
|
|
479
|
+
export type AlertIssuesCreateParams = {
|
|
480
|
+
/** Positional argument */
|
|
481
|
+
target?: string;
|
|
482
|
+
/** Rule name */
|
|
483
|
+
name: string;
|
|
484
|
+
/** Condition object JSON (repeatable, or pass one JSON array) */
|
|
485
|
+
condition?: string;
|
|
486
|
+
/** Action object JSON (repeatable, or pass one JSON array) */
|
|
487
|
+
action?: string;
|
|
488
|
+
/** Condition/action match mode: all or any */
|
|
489
|
+
actionMatch?: string;
|
|
490
|
+
/** Frequency in minutes (default: 30) */
|
|
491
|
+
frequency?: number;
|
|
492
|
+
/** Environment filter */
|
|
493
|
+
environment?: string;
|
|
494
|
+
/** Filter object JSON (repeatable, or pass one JSON array) */
|
|
495
|
+
filter?: string;
|
|
496
|
+
/** Filter match mode: all or any */
|
|
497
|
+
filterMatch?: string;
|
|
498
|
+
/** Owner (team:user style value accepted by Sentry API) */
|
|
499
|
+
owner?: string;
|
|
500
|
+
/** Show what would happen without making changes */
|
|
501
|
+
dryRun?: boolean;
|
|
502
|
+
};
|
|
503
|
+
|
|
504
|
+
export type AlertIssuesDeleteParams = {
|
|
505
|
+
/** Positional argument */
|
|
506
|
+
orgProjectRuleIdOrName?: string;
|
|
507
|
+
/** Skip confirmation prompt */
|
|
508
|
+
yes?: boolean;
|
|
509
|
+
/** Force the operation without confirmation */
|
|
510
|
+
force?: boolean;
|
|
511
|
+
/** Show what would happen without making changes */
|
|
512
|
+
dryRun?: boolean;
|
|
513
|
+
};
|
|
514
|
+
|
|
515
|
+
export type AlertIssuesEditParams = {
|
|
516
|
+
/** Positional argument */
|
|
517
|
+
orgProjectRuleIdOrName?: string;
|
|
518
|
+
/** New rule name */
|
|
519
|
+
name?: string;
|
|
520
|
+
/** Rule status: active or disabled */
|
|
521
|
+
status?: string;
|
|
522
|
+
/** Condition object JSON (repeatable, or pass one JSON array) */
|
|
523
|
+
condition?: string;
|
|
524
|
+
/** Action object JSON (repeatable, or pass one JSON array) */
|
|
525
|
+
action?: string;
|
|
526
|
+
/** Condition/action match mode: all or any */
|
|
527
|
+
actionMatch?: string;
|
|
528
|
+
/** Frequency in minutes */
|
|
529
|
+
frequency?: string;
|
|
530
|
+
/** Environment value (pass empty string to clear) */
|
|
531
|
+
environment?: string;
|
|
532
|
+
/** Filter object JSON (repeatable, or pass one JSON array) */
|
|
533
|
+
filter?: string;
|
|
534
|
+
/** Filter match mode: all or any */
|
|
535
|
+
filterMatch?: string;
|
|
536
|
+
/** Owner value (pass empty string to clear) */
|
|
537
|
+
owner?: string;
|
|
538
|
+
};
|
|
539
|
+
|
|
540
|
+
export type AlertMetricsListParams = {
|
|
541
|
+
/** Positional argument */
|
|
542
|
+
target?: string;
|
|
543
|
+
/** Maximum number of metric alert rules to list */
|
|
544
|
+
limit?: number;
|
|
545
|
+
/** Filter rules by name */
|
|
546
|
+
query?: string;
|
|
547
|
+
/** Pagination cursor (use "next" for next page, "prev" for previous) */
|
|
548
|
+
cursor?: string;
|
|
549
|
+
};
|
|
550
|
+
|
|
551
|
+
export type AlertMetricsViewParams = {
|
|
552
|
+
/** Positional argument */
|
|
553
|
+
orgRuleIdOrName?: string;
|
|
554
|
+
};
|
|
555
|
+
|
|
556
|
+
export type AlertMetricsCreateParams = {
|
|
557
|
+
/** Positional argument */
|
|
558
|
+
org?: string;
|
|
559
|
+
/** Rule name */
|
|
560
|
+
name: string;
|
|
561
|
+
/** Metric query filter string */
|
|
562
|
+
query: string;
|
|
563
|
+
/** Aggregate expression (for example count(), p95(transaction.duration)) */
|
|
564
|
+
aggregate: string;
|
|
565
|
+
/** Dataset (errors, transactions, sessions, events, spans, metrics) */
|
|
566
|
+
dataset: string;
|
|
567
|
+
/** Evaluation window in minutes */
|
|
568
|
+
timeWindow: string;
|
|
569
|
+
/** Trigger object JSON (repeatable, or pass one JSON array) */
|
|
570
|
+
trigger?: string;
|
|
571
|
+
/** Project slug filter (repeatable or comma-separated) */
|
|
572
|
+
project?: string;
|
|
573
|
+
/** Environment filter */
|
|
574
|
+
environment?: string;
|
|
575
|
+
/** Owner value accepted by Sentry API */
|
|
576
|
+
owner?: string;
|
|
577
|
+
/** Show what would happen without making changes */
|
|
578
|
+
dryRun?: boolean;
|
|
579
|
+
};
|
|
580
|
+
|
|
581
|
+
export type AlertMetricsDeleteParams = {
|
|
582
|
+
/** Positional argument */
|
|
583
|
+
orgRuleIdOrName?: string;
|
|
584
|
+
/** Skip confirmation prompt */
|
|
585
|
+
yes?: boolean;
|
|
586
|
+
/** Force the operation without confirmation */
|
|
587
|
+
force?: boolean;
|
|
588
|
+
/** Show what would happen without making changes */
|
|
589
|
+
dryRun?: boolean;
|
|
590
|
+
};
|
|
591
|
+
|
|
592
|
+
export type AlertMetricsEditParams = {
|
|
593
|
+
/** Positional argument */
|
|
594
|
+
orgRuleIdOrName?: string;
|
|
595
|
+
/** New rule name */
|
|
596
|
+
name?: string;
|
|
597
|
+
/** active or disabled */
|
|
598
|
+
status?: string;
|
|
599
|
+
/** Metric query filter */
|
|
600
|
+
query?: string;
|
|
601
|
+
/** Aggregate expression */
|
|
602
|
+
aggregate?: string;
|
|
603
|
+
/** Dataset (errors, transactions, sessions, events, spans, metrics) */
|
|
604
|
+
dataset?: string;
|
|
605
|
+
/** Evaluation window in minutes */
|
|
606
|
+
timeWindow?: string;
|
|
607
|
+
/** Trigger object JSON (repeatable, or pass one JSON array) */
|
|
608
|
+
trigger?: string;
|
|
609
|
+
/** Project slug filter (repeatable or comma-separated) */
|
|
610
|
+
project?: string;
|
|
611
|
+
/** Environment value (pass empty string to clear) */
|
|
612
|
+
environment?: string;
|
|
613
|
+
/** Owner value (pass empty string to clear) */
|
|
614
|
+
owner?: string;
|
|
615
|
+
};
|
|
616
|
+
|
|
395
617
|
export type AuthLoginParams = {
|
|
396
618
|
/** Authenticate using an API token instead of OAuth */
|
|
397
619
|
token?: string;
|
|
@@ -401,11 +623,19 @@ export type AuthLoginParams = {
|
|
|
401
623
|
force?: boolean;
|
|
402
624
|
/** Sentry instance URL to authenticate against (e.g. https://sentry.example.com). Required for self-hosted; defaults to SaaS (https://sentry.io). */
|
|
403
625
|
url?: string;
|
|
626
|
+
/** Request only read-only OAuth scopes (project:read, org:read, event:read, member:read, team:read). Useful for handing tokens to AI agents or CI jobs that should not be able to mutate Sentry state. */
|
|
627
|
+
readOnly?: boolean;
|
|
628
|
+
/** Request specific OAuth scopes (repeatable, comma-separated). E.g. --scope project:read --scope org:read. Overrides the default scope set. */
|
|
629
|
+
scope?: string;
|
|
404
630
|
};
|
|
405
631
|
|
|
406
632
|
export type AuthRefreshParams = {
|
|
407
633
|
/** Force refresh even if token is still valid */
|
|
408
634
|
force?: boolean;
|
|
635
|
+
/** Re-authenticate with read-only OAuth scopes (project:read, org:read, event:read, member:read, team:read) */
|
|
636
|
+
readOnly?: boolean;
|
|
637
|
+
/** Re-authenticate with specific OAuth scopes (repeatable, comma-separated). E.g. --scope project:read --scope org:read */
|
|
638
|
+
scope?: string;
|
|
409
639
|
};
|
|
410
640
|
|
|
411
641
|
export type AuthStatusParams = {
|
|
@@ -427,6 +657,17 @@ export type CliFixParams = {
|
|
|
427
657
|
dryRun?: boolean;
|
|
428
658
|
};
|
|
429
659
|
|
|
660
|
+
export type CliImportParams = {
|
|
661
|
+
/** Skip confirmation prompt */
|
|
662
|
+
yes?: boolean;
|
|
663
|
+
/** Show what would happen without making changes */
|
|
664
|
+
dryRun?: boolean;
|
|
665
|
+
/** Explicitly trust this URL (bypasses same-file trust check) */
|
|
666
|
+
url?: string;
|
|
667
|
+
/** Skip token validation against the Sentry API */
|
|
668
|
+
skipValidation?: boolean;
|
|
669
|
+
};
|
|
670
|
+
|
|
430
671
|
export type CliSetupParams = {
|
|
431
672
|
/** Install the binary from a temp location to the system path */
|
|
432
673
|
install?: boolean;
|
|
@@ -467,7 +708,7 @@ export type DashboardListParams = {
|
|
|
467
708
|
export type DashboardViewParams = {
|
|
468
709
|
/** Auto-refresh interval in seconds (default: 60, min: 10) */
|
|
469
710
|
refresh?: string;
|
|
470
|
-
/** Time range: "7d", "2026-
|
|
711
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
471
712
|
period?: string;
|
|
472
713
|
};
|
|
473
714
|
|
|
@@ -600,6 +841,20 @@ export type ProjectViewParams = {
|
|
|
600
841
|
orgProject?: string;
|
|
601
842
|
};
|
|
602
843
|
|
|
844
|
+
export type ProguardUploadParams = {
|
|
845
|
+
/** Force a specific UUID instead of computing from file content (only valid with a single file) */
|
|
846
|
+
uuid?: string;
|
|
847
|
+
/** Compute and print UUIDs without uploading (dry-run) */
|
|
848
|
+
noUpload?: boolean;
|
|
849
|
+
/** Require at least one mapping file (error if none provided) */
|
|
850
|
+
requireOne?: boolean;
|
|
851
|
+
};
|
|
852
|
+
|
|
853
|
+
export type ProguardUuidParams = {
|
|
854
|
+
/** Positional argument */
|
|
855
|
+
path?: string;
|
|
856
|
+
};
|
|
857
|
+
|
|
603
858
|
export type ReplayListParams = {
|
|
604
859
|
/** Positional argument */
|
|
605
860
|
orgProject?: string;
|
|
@@ -611,7 +866,7 @@ export type ReplayListParams = {
|
|
|
611
866
|
environment?: string;
|
|
612
867
|
/** Sort by: date, oldest, duration, errors, activity, or a raw replay sort field */
|
|
613
868
|
sort?: string;
|
|
614
|
-
/** Time range: "7d", "2026-
|
|
869
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
615
870
|
period?: string;
|
|
616
871
|
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
617
872
|
cursor?: string;
|
|
@@ -634,7 +889,14 @@ export type ReleaseListParams = {
|
|
|
634
889
|
cursor?: string;
|
|
635
890
|
};
|
|
636
891
|
|
|
892
|
+
export type ReleaseViewParams = {
|
|
893
|
+
/** Positional argument */
|
|
894
|
+
orgVersion?: string;
|
|
895
|
+
};
|
|
896
|
+
|
|
637
897
|
export type ReleaseCreateParams = {
|
|
898
|
+
/** Positional argument */
|
|
899
|
+
orgVersion?: string;
|
|
638
900
|
/** Associate with project(s), comma-separated */
|
|
639
901
|
project?: string;
|
|
640
902
|
/** Immediately finalize the release (set dateReleased) */
|
|
@@ -648,6 +910,8 @@ export type ReleaseCreateParams = {
|
|
|
648
910
|
};
|
|
649
911
|
|
|
650
912
|
export type ReleaseFinalizeParams = {
|
|
913
|
+
/** Positional argument */
|
|
914
|
+
orgVersion?: string;
|
|
651
915
|
/** Custom release timestamp (ISO 8601). Defaults to now. */
|
|
652
916
|
released?: string;
|
|
653
917
|
/** URL for the release */
|
|
@@ -657,6 +921,8 @@ export type ReleaseFinalizeParams = {
|
|
|
657
921
|
};
|
|
658
922
|
|
|
659
923
|
export type ReleaseDeleteParams = {
|
|
924
|
+
/** Positional argument */
|
|
925
|
+
orgVersion?: string;
|
|
660
926
|
/** Skip confirmation prompt */
|
|
661
927
|
yes?: boolean;
|
|
662
928
|
/** Force the operation without confirmation */
|
|
@@ -665,7 +931,23 @@ export type ReleaseDeleteParams = {
|
|
|
665
931
|
dryRun?: boolean;
|
|
666
932
|
};
|
|
667
933
|
|
|
934
|
+
export type ReleaseArchiveParams = {
|
|
935
|
+
/** Positional argument */
|
|
936
|
+
orgVersion?: string;
|
|
937
|
+
/** Show what would happen without making changes */
|
|
938
|
+
dryRun?: boolean;
|
|
939
|
+
};
|
|
940
|
+
|
|
941
|
+
export type ReleaseRestoreParams = {
|
|
942
|
+
/** Positional argument */
|
|
943
|
+
orgVersion?: string;
|
|
944
|
+
/** Show what would happen without making changes */
|
|
945
|
+
dryRun?: boolean;
|
|
946
|
+
};
|
|
947
|
+
|
|
668
948
|
export type ReleaseDeployParams = {
|
|
949
|
+
/** Positional argument */
|
|
950
|
+
orgVersionEnvironmentName?: string;
|
|
669
951
|
/** URL for the deploy */
|
|
670
952
|
url?: string;
|
|
671
953
|
/** Deploy start time (ISO 8601) */
|
|
@@ -678,7 +960,14 @@ export type ReleaseDeployParams = {
|
|
|
678
960
|
dryRun?: boolean;
|
|
679
961
|
};
|
|
680
962
|
|
|
963
|
+
export type ReleaseDeploysParams = {
|
|
964
|
+
/** Positional argument */
|
|
965
|
+
orgVersion?: string;
|
|
966
|
+
};
|
|
967
|
+
|
|
681
968
|
export type ReleaseSetCommitsParams = {
|
|
969
|
+
/** Positional argument */
|
|
970
|
+
orgVersion?: string;
|
|
682
971
|
/** Auto-discover commits via repository integration (needs local git checkout) */
|
|
683
972
|
auto?: boolean;
|
|
684
973
|
/** Read commits from local git history */
|
|
@@ -718,7 +1007,7 @@ export type IssueListParams = {
|
|
|
718
1007
|
limit?: number;
|
|
719
1008
|
/** Sort by: date, new, freq, user */
|
|
720
1009
|
sort?: string;
|
|
721
|
-
/** Time range: "7d", "2026-
|
|
1010
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
722
1011
|
period?: string;
|
|
723
1012
|
/** Pagination cursor (use "next" for next page, "prev" for previous) */
|
|
724
1013
|
cursor?: string;
|
|
@@ -733,7 +1022,7 @@ export type IssueEventsParams = {
|
|
|
733
1022
|
query?: string;
|
|
734
1023
|
/** Include full event body (stacktraces) */
|
|
735
1024
|
full?: boolean;
|
|
736
|
-
/** Time range: "7d", "2026-
|
|
1025
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
737
1026
|
period?: string;
|
|
738
1027
|
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
739
1028
|
cursor?: string;
|
|
@@ -798,12 +1087,49 @@ export type EventListParams = {
|
|
|
798
1087
|
query?: string;
|
|
799
1088
|
/** Include full event body (stacktraces) */
|
|
800
1089
|
full?: boolean;
|
|
801
|
-
/** Time range: "7d", "2026-
|
|
1090
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
802
1091
|
period?: string;
|
|
803
1092
|
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
804
1093
|
cursor?: string;
|
|
805
1094
|
};
|
|
806
1095
|
|
|
1096
|
+
export type EventSendParams = {
|
|
1097
|
+
/** DSN to send events to (overrides SENTRY_DSN env var) */
|
|
1098
|
+
dsn?: string;
|
|
1099
|
+
/** Event message (repeat for multi-line) */
|
|
1100
|
+
message?: string;
|
|
1101
|
+
/** Arguments for message template (repeat for multiple) */
|
|
1102
|
+
messageArg?: string;
|
|
1103
|
+
/** Event severity level */
|
|
1104
|
+
level?: "debug" | "info" | "warning" | "error" | "fatal";
|
|
1105
|
+
/** Release version */
|
|
1106
|
+
release?: string;
|
|
1107
|
+
/** Distribution identifier */
|
|
1108
|
+
dist?: string;
|
|
1109
|
+
/** Environment name (e.g. production, staging) */
|
|
1110
|
+
env?: string;
|
|
1111
|
+
/** Platform identifier (default: other) */
|
|
1112
|
+
platform?: string;
|
|
1113
|
+
/** Tag as KEY:VALUE (repeat for multiple) */
|
|
1114
|
+
tag?: string;
|
|
1115
|
+
/** Extra data as KEY:VALUE (repeat for multiple) */
|
|
1116
|
+
extra?: string;
|
|
1117
|
+
/** User info as KEY:VALUE — id, email, username, ip_address, or custom */
|
|
1118
|
+
user?: string;
|
|
1119
|
+
/** Custom fingerprint part (repeat for multiple) */
|
|
1120
|
+
fingerprint?: string;
|
|
1121
|
+
/** Event timestamp (Unix epoch, ISO 8601, or RFC 2822) */
|
|
1122
|
+
timestamp?: string;
|
|
1123
|
+
/** Do not include environment variables in the event */
|
|
1124
|
+
noEnviron?: boolean;
|
|
1125
|
+
/** Path to a log file — last 100 lines are attached as breadcrumbs */
|
|
1126
|
+
logfile?: string;
|
|
1127
|
+
/** Parse 'CATEGORY: message' prefixes from logfile breadcrumbs */
|
|
1128
|
+
withCategories?: boolean;
|
|
1129
|
+
/** Send file contents as-is without parsing */
|
|
1130
|
+
raw?: boolean;
|
|
1131
|
+
};
|
|
1132
|
+
|
|
807
1133
|
export type ExploreParams = {
|
|
808
1134
|
/** Positional argument */
|
|
809
1135
|
target?: string;
|
|
@@ -823,7 +1149,7 @@ export type ExploreParams = {
|
|
|
823
1149
|
environment?: string;
|
|
824
1150
|
/** Number of rows (1-1000) */
|
|
825
1151
|
limit?: number;
|
|
826
|
-
/** Time range: "7d", "2026-
|
|
1152
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
827
1153
|
period?: string;
|
|
828
1154
|
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
829
1155
|
cursor?: string;
|
|
@@ -836,12 +1162,40 @@ export type LogListParams = {
|
|
|
836
1162
|
query?: string;
|
|
837
1163
|
/** Stream logs (optionally specify poll interval in seconds) */
|
|
838
1164
|
follow?: string;
|
|
839
|
-
/** Time range: "7d", "2026-
|
|
1165
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
840
1166
|
period?: string;
|
|
841
1167
|
/** Sort order: "newest" (default) or "oldest" */
|
|
842
1168
|
sort?: string;
|
|
843
1169
|
};
|
|
844
1170
|
|
|
1171
|
+
export type MonitorRunParams = {
|
|
1172
|
+
/** DSN to send check-ins to (overrides SENTRY_DSN env var) */
|
|
1173
|
+
dsn?: string;
|
|
1174
|
+
/** Environment of the monitor */
|
|
1175
|
+
environment?: string;
|
|
1176
|
+
/** Upsert the monitor with this crontab schedule (e.g. '0 * * * *') */
|
|
1177
|
+
schedule?: string;
|
|
1178
|
+
/** Minutes after the expected check-in before it is missed (requires --schedule) */
|
|
1179
|
+
checkInMargin?: string;
|
|
1180
|
+
/** Minutes a check-in may run before timing out (requires --schedule) */
|
|
1181
|
+
maxRuntime?: string;
|
|
1182
|
+
/** Timezone of the schedule, tz database string (requires --schedule) */
|
|
1183
|
+
timezone?: string;
|
|
1184
|
+
/** Consecutive failures before an issue is created (requires --schedule) */
|
|
1185
|
+
failureIssueThreshold?: string;
|
|
1186
|
+
/** Consecutive successes before an issue is resolved (requires --schedule) */
|
|
1187
|
+
recoveryThreshold?: string;
|
|
1188
|
+
};
|
|
1189
|
+
|
|
1190
|
+
export type MonitorListParams = {
|
|
1191
|
+
/** Positional argument */
|
|
1192
|
+
orgProject?: string;
|
|
1193
|
+
/** Maximum number of monitors to list */
|
|
1194
|
+
limit?: number;
|
|
1195
|
+
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
1196
|
+
cursor?: string;
|
|
1197
|
+
};
|
|
1198
|
+
|
|
845
1199
|
export type SourcemapInjectParams = {
|
|
846
1200
|
/** Positional argument */
|
|
847
1201
|
directory?: string;
|
|
@@ -882,6 +1236,17 @@ export type SourcemapUploadParams = {
|
|
|
882
1236
|
allowEmpty?: boolean;
|
|
883
1237
|
};
|
|
884
1238
|
|
|
1239
|
+
export type SourcemapResolveParams = {
|
|
1240
|
+
/** Positional argument */
|
|
1241
|
+
directory?: string;
|
|
1242
|
+
/** Comma-separated file extensions to process (default: .js,.cjs,.mjs) */
|
|
1243
|
+
ext?: string;
|
|
1244
|
+
/** Comma-separated glob patterns to exclude (gitignore-style) */
|
|
1245
|
+
ignore?: string;
|
|
1246
|
+
/** Path to a file with gitignore-style patterns to exclude */
|
|
1247
|
+
ignoreFile?: string;
|
|
1248
|
+
};
|
|
1249
|
+
|
|
885
1250
|
export type SpanListParams = {
|
|
886
1251
|
/** Number of spans (<=1000) */
|
|
887
1252
|
limit?: number;
|
|
@@ -889,7 +1254,7 @@ export type SpanListParams = {
|
|
|
889
1254
|
query?: string;
|
|
890
1255
|
/** Sort order: date, duration */
|
|
891
1256
|
sort?: string;
|
|
892
|
-
/** Time range: "7d", "2026-
|
|
1257
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
893
1258
|
period?: string;
|
|
894
1259
|
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
895
1260
|
cursor?: string;
|
|
@@ -909,7 +1274,7 @@ export type TraceListParams = {
|
|
|
909
1274
|
query?: string;
|
|
910
1275
|
/** Sort by: date, duration */
|
|
911
1276
|
sort?: string;
|
|
912
|
-
/** Time range: "7d", "2026-
|
|
1277
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
913
1278
|
period?: string;
|
|
914
1279
|
/** Navigate pages: "next", "prev", "first" (or raw cursor string) */
|
|
915
1280
|
cursor?: string;
|
|
@@ -923,7 +1288,7 @@ export type TraceViewParams = {
|
|
|
923
1288
|
};
|
|
924
1289
|
|
|
925
1290
|
export type TraceLogsParams = {
|
|
926
|
-
/** Time range: "7d", "2026-
|
|
1291
|
+
/** Time range: "7d", "2026-05-01..2026-06-01", ">=2026-05-01" */
|
|
927
1292
|
period?: string;
|
|
928
1293
|
/** Number of log entries (<=1000) */
|
|
929
1294
|
limit?: number;
|
|
@@ -954,10 +1319,36 @@ export type InitParams = {
|
|
|
954
1319
|
features?: string;
|
|
955
1320
|
/** Team slug to create the project under */
|
|
956
1321
|
team?: string;
|
|
1322
|
+
/** App to initialize in a monorepo (required with --yes when multiple apps are detected) */
|
|
1323
|
+
app?: string;
|
|
957
1324
|
/** Use the Ink-based interactive UI (default). Pass --no-tui to fall back to plain log output. */
|
|
958
1325
|
tui?: boolean;
|
|
959
1326
|
};
|
|
960
1327
|
|
|
1328
|
+
export type LocalServeParams = {
|
|
1329
|
+
/** Port to listen on (default 8969) */
|
|
1330
|
+
port?: number;
|
|
1331
|
+
/** Hostname to bind to (default localhost) */
|
|
1332
|
+
host?: string;
|
|
1333
|
+
/** Suppress per-envelope tail output */
|
|
1334
|
+
quiet?: boolean;
|
|
1335
|
+
/** Only show items of this type (repeatable: error, transaction, log, ai) */
|
|
1336
|
+
filter?: string;
|
|
1337
|
+
/** Output format: human (default) or json (NDJSON) */
|
|
1338
|
+
format?: string;
|
|
1339
|
+
};
|
|
1340
|
+
|
|
1341
|
+
export type LocalRunParams = {
|
|
1342
|
+
/** Port for the local server (default 8969) */
|
|
1343
|
+
port?: number;
|
|
1344
|
+
/** Hostname for the local server (default localhost) */
|
|
1345
|
+
host?: string;
|
|
1346
|
+
/** Verify SDK sends events, then exit */
|
|
1347
|
+
verify?: boolean;
|
|
1348
|
+
/** Kill the child after N seconds (0 = no timeout; defaults to 30 s in --verify mode) */
|
|
1349
|
+
timeout?: number;
|
|
1350
|
+
};
|
|
1351
|
+
|
|
961
1352
|
export type ApiParams = {
|
|
962
1353
|
/** Positional argument */
|
|
963
1354
|
endpoint?: string;
|
|
@@ -999,6 +1390,32 @@ export type SentrySDK = {
|
|
|
999
1390
|
api(params?: ApiParams): Promise<unknown>;
|
|
1000
1391
|
/** Browse the Sentry API schema */
|
|
1001
1392
|
schema(params?: SchemaParams, ...positional: string[]): Promise<unknown>;
|
|
1393
|
+
alert: {
|
|
1394
|
+
issues: {
|
|
1395
|
+
/** List issue alert rules */
|
|
1396
|
+
list(params?: AlertIssuesListParams): Promise<unknown>;
|
|
1397
|
+
/** View an issue alert rule */
|
|
1398
|
+
view(params?: AlertIssuesViewParams): Promise<unknown>;
|
|
1399
|
+
/** Create an issue alert rule */
|
|
1400
|
+
create(params: AlertIssuesCreateParams): Promise<unknown>;
|
|
1401
|
+
/** Delete an issue alert rule */
|
|
1402
|
+
delete(params?: AlertIssuesDeleteParams): Promise<unknown>;
|
|
1403
|
+
/** Edit an issue alert rule */
|
|
1404
|
+
edit(params?: AlertIssuesEditParams): Promise<unknown>;
|
|
1405
|
+
};
|
|
1406
|
+
metrics: {
|
|
1407
|
+
/** List metric alert rules */
|
|
1408
|
+
list(params?: AlertMetricsListParams): Promise<unknown>;
|
|
1409
|
+
/** View a metric alert rule */
|
|
1410
|
+
view(params?: AlertMetricsViewParams): Promise<unknown>;
|
|
1411
|
+
/** Create a metric alert rule */
|
|
1412
|
+
create(params: AlertMetricsCreateParams): Promise<unknown>;
|
|
1413
|
+
/** Delete a metric alert rule */
|
|
1414
|
+
delete(params?: AlertMetricsDeleteParams): Promise<unknown>;
|
|
1415
|
+
/** Edit a metric alert rule */
|
|
1416
|
+
edit(params?: AlertMetricsEditParams): Promise<unknown>;
|
|
1417
|
+
};
|
|
1418
|
+
};
|
|
1002
1419
|
auth: {
|
|
1003
1420
|
/** Authenticate with Sentry */
|
|
1004
1421
|
login(params?: AuthLoginParams): Promise<unknown>;
|
|
@@ -1020,6 +1437,8 @@ export type SentrySDK = {
|
|
|
1020
1437
|
feedback(...positional: string[]): Promise<unknown>;
|
|
1021
1438
|
/** Diagnose and repair CLI database issues */
|
|
1022
1439
|
fix(params?: CliFixParams): Promise<unknown>;
|
|
1440
|
+
/** Import settings from legacy .sentryclirc files */
|
|
1441
|
+
import(params?: CliImportParams): Promise<unknown>;
|
|
1023
1442
|
/** Configure shell integration */
|
|
1024
1443
|
setup(params?: CliSetupParams): Promise<unknown>;
|
|
1025
1444
|
/** Update the Sentry CLI to the latest version */
|
|
@@ -1064,6 +1483,12 @@ export type SentrySDK = {
|
|
|
1064
1483
|
/** View details of a project */
|
|
1065
1484
|
view(params?: ProjectViewParams): Promise<unknown>;
|
|
1066
1485
|
};
|
|
1486
|
+
proguard: {
|
|
1487
|
+
/** Upload ProGuard/R8 mapping files to Sentry */
|
|
1488
|
+
upload(params?: ProguardUploadParams, ...positional: string[]): Promise<unknown>;
|
|
1489
|
+
/** Compute the UUID for a ProGuard mapping file */
|
|
1490
|
+
uuid(params?: ProguardUuidParams): Promise<unknown>;
|
|
1491
|
+
};
|
|
1067
1492
|
replay: {
|
|
1068
1493
|
/** List recent Session Replays */
|
|
1069
1494
|
list(params?: ReplayListParams): Promise<ReplayListResult>;
|
|
@@ -1074,19 +1499,23 @@ export type SentrySDK = {
|
|
|
1074
1499
|
/** List releases with adoption and health metrics */
|
|
1075
1500
|
list(params?: ReleaseListParams): Promise<unknown>;
|
|
1076
1501
|
/** View release details with health metrics */
|
|
1077
|
-
view(
|
|
1502
|
+
view(params?: ReleaseViewParams): Promise<unknown>;
|
|
1078
1503
|
/** Create a release */
|
|
1079
|
-
create(params?: ReleaseCreateParams
|
|
1504
|
+
create(params?: ReleaseCreateParams): Promise<unknown>;
|
|
1080
1505
|
/** Finalize a release */
|
|
1081
|
-
finalize(params?: ReleaseFinalizeParams
|
|
1506
|
+
finalize(params?: ReleaseFinalizeParams): Promise<unknown>;
|
|
1082
1507
|
/** Delete a release */
|
|
1083
|
-
delete(params?: ReleaseDeleteParams
|
|
1508
|
+
delete(params?: ReleaseDeleteParams): Promise<unknown>;
|
|
1509
|
+
/** Archive a release */
|
|
1510
|
+
archive(params?: ReleaseArchiveParams): Promise<unknown>;
|
|
1511
|
+
/** Restore an archived release */
|
|
1512
|
+
restore(params?: ReleaseRestoreParams): Promise<unknown>;
|
|
1084
1513
|
/** Create a deploy for a release */
|
|
1085
|
-
deploy(params?: ReleaseDeployParams
|
|
1514
|
+
deploy(params?: ReleaseDeployParams): Promise<unknown>;
|
|
1086
1515
|
/** List deploys for a release */
|
|
1087
|
-
deploys(
|
|
1516
|
+
deploys(params?: ReleaseDeploysParams): Promise<unknown>;
|
|
1088
1517
|
/** Set commits for a release */
|
|
1089
|
-
"set-commits"(params?: ReleaseSetCommitsParams
|
|
1518
|
+
"set-commits"(params?: ReleaseSetCommitsParams): Promise<unknown>;
|
|
1090
1519
|
/** Propose a release version */
|
|
1091
1520
|
"propose-version"(): Promise<unknown>;
|
|
1092
1521
|
};
|
|
@@ -1108,7 +1537,7 @@ export type SentrySDK = {
|
|
|
1108
1537
|
/** Generate a solution plan using Seer AI */
|
|
1109
1538
|
plan(params?: IssuePlanParams): Promise<unknown>;
|
|
1110
1539
|
/** View details of a specific issue */
|
|
1111
|
-
view(params?: IssueViewParams): Promise<
|
|
1540
|
+
view(params?: IssueViewParams): Promise<IssueViewResult>;
|
|
1112
1541
|
/** Mark an issue as resolved */
|
|
1113
1542
|
resolve(params?: IssueResolveParams): Promise<unknown>;
|
|
1114
1543
|
/** Reopen a resolved issue */
|
|
@@ -1123,6 +1552,8 @@ export type SentrySDK = {
|
|
|
1123
1552
|
view(params?: EventViewParams, ...positional: string[]): Promise<unknown>;
|
|
1124
1553
|
/** List events for an issue */
|
|
1125
1554
|
list(params?: EventListParams): Promise<EventListResult>;
|
|
1555
|
+
/** Send a Sentry event */
|
|
1556
|
+
send(params?: EventSendParams, ...positional: string[]): Promise<unknown>;
|
|
1126
1557
|
};
|
|
1127
1558
|
log: {
|
|
1128
1559
|
/** List logs from a project */
|
|
@@ -1133,11 +1564,19 @@ export type SentrySDK = {
|
|
|
1133
1564
|
/** View details of one or more log entries */
|
|
1134
1565
|
view(...positional: string[]): Promise<unknown>;
|
|
1135
1566
|
};
|
|
1567
|
+
monitor: {
|
|
1568
|
+
/** Wrap a command with cron monitor check-ins */
|
|
1569
|
+
run(params?: MonitorRunParams, ...positional: string[]): Promise<unknown>;
|
|
1570
|
+
/** List cron monitors */
|
|
1571
|
+
list(params?: MonitorListParams): Promise<MonitorListResult>;
|
|
1572
|
+
};
|
|
1136
1573
|
sourcemap: {
|
|
1137
1574
|
/** Inject debug IDs into JavaScript files and sourcemaps */
|
|
1138
1575
|
inject(params?: SourcemapInjectParams): Promise<unknown>;
|
|
1139
1576
|
/** Upload sourcemaps to Sentry */
|
|
1140
1577
|
upload(params?: SourcemapUploadParams): Promise<unknown>;
|
|
1578
|
+
/** Resolve and report sourcemap linkage for JavaScript files */
|
|
1579
|
+
resolve(params?: SourcemapResolveParams): Promise<unknown>;
|
|
1141
1580
|
};
|
|
1142
1581
|
span: {
|
|
1143
1582
|
/** List spans in a project or trace */
|
|
@@ -1159,5 +1598,11 @@ export type SentrySDK = {
|
|
|
1159
1598
|
/** Start a product trial */
|
|
1160
1599
|
start(params?: TrialStartParams): Promise<unknown>;
|
|
1161
1600
|
};
|
|
1601
|
+
local: {
|
|
1602
|
+
/** Start the local dev server and tail events */
|
|
1603
|
+
serve(params?: LocalServeParams): Promise<unknown>;
|
|
1604
|
+
/** Run a command with the local dev server enabled */
|
|
1605
|
+
run(params?: LocalRunParams, ...positional: string[]): Promise<unknown>;
|
|
1606
|
+
};
|
|
1162
1607
|
};
|
|
1163
1608
|
|