Diagnostics

Ingest a cross-instance diagnostic report

Public receiver for privacy-limited diagnostic reports sent by OpenPost instances. Strictly validated and quota-limited; accepted reports are forwarded to the maintainer channel.

post/diagnostics/ingest

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/diagnostics/ingest
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

attempt_countinteger

Attempt count, when relevant

db_driverstring

Normalized database driver

error_codestring required

Normalized error code from the diagnostics catalog

error_kind'deadline_exceeded' | 'canceled' | 'not_found' | 'permission_denied' | 'connection_refused' | 'connection_reset' | 'unexpected_eof' | 'dns_error' | 'network_timeout' | 'runtime_error' | 'type_error' | 'reference_error' | 'range_error' | 'syntax_error' | 'quota_exceeded' | 'security_error' | 'not_supported' | 'invalid_state' | 'abort_error' | 'network_error'

Allowlisted error type, never message text

first_seenstring

RFC3339 first observation, when known

http_method'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'CONNECT' | 'TRACE'

HTTP request method, when relevant

http_statusinteger

HTTP status, when relevant

installation_idstring required

Random installation ID generated by the sending instance

last_seenstring

RFC3339 last observation, when known

occurrence_countinteger

Aggregated occurrence count

operationstring required

Route template, job type, or operation name

providerstring

First-party platform, when relevant

retry_countinteger

Retry count, when relevant

revisionstring required

OpenPost source revision reported by the sending instance

storage_driverstring

Normalized media storage driver

surface'browser' | 'backend' | 'worker' required

Surface where the failure was observed

versionstring required

OpenPost release reported by the sending instance

Example request

{
  "$schema": "https://example.com/api/v1/schemas/IngestDiagnosticsInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

acceptedboolean required

Example response

{
  "$schema": "https://example.com/api/v1/schemas/IngestDiagnosticsOutputBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.