schema
Browse the Sentry API schema
sentry schema <query...>
Section titled “sentry schema <query...>”Browse the Sentry API schema
Arguments:
| Argument | Description |
|---|---|
<query...> |
API concept, CLI command path, exact operation ID, or METHOD /path |
Options:
| Option | Description |
|---|---|
--all |
Show all endpoints in a flat list |
-q, --search <search> |
Search endpoints by keyword |
Examples:
# List all API resourcessentry schema
# Browse issue endpointssentry schema issues
# Find list operations (there may be multiple candidates)sentry schema issues list
# Find APIs used by log listingsentry schema log list
# Find APIs used by trace listing, including command aliasessentry schema trace ls
# Find APIs used by a command groupsentry schema alert metrics
# Find APIs used by a nested commandsentry schema alert metrics view
# Look up an endpoint by its exact operation IDsentry schema listOrganizationEvents
# Look up an endpoint by HTTP method and pathsentry schema "GET /api/0/organizations/{organization_id_or_slug}/issues/"
# Search for monitoring-related endpointssentry schema --search monitor
# Browse resources matching a globsentry schema 'monitor*'
# Flat list of every endpointsentry schema --allAll commands support --json for machine-readable output and --fields to select specific JSON fields.
Discovery includes summaries, paths, tags, and query parameter values: logs
can find Explore's dataset=logs as well as feature-flag audit logs. Results
explain their matches and show related CLI commands discovered from command
implementations. A related API does not necessarily reproduce the command's filters,
pagination, or transformations.
Use sentry help <command> for CLI flags and usage examples. Schema describes
API operations and parameters for constructing requests with sentry api.
Use an exact operation ID, SDK function name, or HTTP method and path for a precise lookup. Concept searches return all matching candidates; deprecated operations are marked and sorted after active ones. No endpoint is chosen just because it appears first in the catalog.
With --json, discovery returns an array of endpoints with additive match
metadata. Exact single-endpoint lookups remain endpoint objects, --search
always returns an array, and --all returns the flat catalog without match
metadata. The schema is bundled from the CLI's SDK version and works offline.