Gitpod API Reference | Errors

API Reference

Errors

errors

Methods

Report Errors -> unknown

post/gitpod.v1.ErrorsService/ReportErrors

ReportErrors allows clients to report batches of errors that will be sent to error reporting systems. The structure is fully compatible with Sentry's event payload format.

Use this method to:

Report client-side errors and exceptions
Track application crashes and panics
Send error context and metadata for debugging

Examples

Report a JavaScript error with Sentry-compatible structure: The service accepts events with comprehensive error information including stack traces, identity context, breadcrumbs, and metadata that align with Sentry's event payload format.

Request example

curl https://app.gitpod.io/api/gitpod.v1.ErrorsService/ReportErrors \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

200Example

{}

Domain types

Breadcrumb = { category, data, level, 3 more... }

Breadcrumb information (Sentry-compatible)

ErrorEvent = { breadcrumbs, environment, eventId, 15 more... }

ErrorEvent contains comprehensive error information (Sentry-compatible)

ErrorLevel = "ERROR_LEVEL_UNSPECIFIED" | "ERROR_LEVEL_DEBUG" | "ERROR_LEVEL_INFO" | 3 more...

Error severity levels (aligned with Sentry levels)

ExceptionInfo = { mechanism, module, stacktrace, 3 more... }

Exception information (Sentry-compatible)

ExceptionMechanism = { data, description, handled, 2 more... }

Exception mechanism information (Sentry-compatible)

RequestInfo = { data, headers, method, 2 more... }

Request information (Sentry-compatible)

StackFrame = { colno, contextLine, filename, 7 more... }

Stack trace frame information (Sentry-compatible)