api

Make an authenticated API request

Usage

sentry api <endpoint>

Make an authenticated API request

Arguments:

Argument	Description
<endpoint>	API endpoint relative to /api/0/ (e.g., organizations/)

Options:

Option	Description
-X, --method <method>	The HTTP method for the request (default: "GET")
-d, --data <data>	Inline JSON body for the request (like curl -d)
-F, --field <field>...	Add a typed parameter (key=value, key[sub]=value, key[]=value)
-f, --raw-field <raw-field>...	Add a string parameter without JSON parsing
-H, --header <header>...	Add a HTTP request header in key:value format
--input <input>	The file to use as body for the HTTP request (use "-" to read from standard input)
--silent	Do not print the response body
--verbose	Include full HTTP request and response in the output
-n, --dry-run	Show the resolved request without sending it

All commands support --json for machine-readable output and --fields to select specific JSON fields.

Examples

Endpoints are relative to /api/0/ — the prefix is added automatically.

GET requests

# List organizations
sentry api organizations/

# Get a specific issue
sentry api issues/123456789/

POST requests

# Create a release
sentry api organizations/my-org/releases/ \
  -X POST -F version=1.0.0

# With inline JSON body
sentry api issues/123456789/ \
  -X POST -d '{"status": "resolved"}'

PUT requests

# Update an issue status
sentry api issues/123456789/ \
  -X PUT -F status=resolved

# Assign an issue
sentry api issues/123456789/ \
  -X PUT --field assignedTo="user@example.com"

DELETE requests

sentry api projects/my-org/my-project/ -X DELETE

Advanced usage

# Add custom headers
sentry api organizations/ -H "X-Custom: value"

# Read body from a file
sentry api projects/my-org/my-project/releases/ -X POST --input release.json

# Verbose mode (shows full HTTP request/response)
sentry api organizations/ --verbose

# Preview the request without sending
sentry api organizations/ --dry-run

Dataset Names

When querying the Events API (/events/ endpoint), valid dataset values are: spans, logs, errors, tracemetrics, profile_functions, and uptime_results.

Binary responses

Endpoints that return binary data — image attachments, minidumps, debug files — are streamed to stdout as raw bytes, so you can redirect them straight to a file:

sentry api "projects/my-org/my-project/events/EVENT_ID/attachments/ATTACHMENT_ID/?download=1" > screenshot.png

When the response is a PNG or JPEG image and you're on a graphics-capable terminal, the image is rendered inline instead of dumping raw bytes into your session. Terminals that speak the newer kitty graphics protocol (kitty, WezTerm, Ghostty, recent Konsole) are used in preference to sixel, which remains the fallback for older terminals. Redirecting or piping stdout always keeps the raw bytes. Set SENTRY_NO_SIXEL=1 to disable inline rendering.

For full API documentation, see the Sentry API Reference.