OpenPost Diagnostics API

The Diagnostics API from OpenPost — 4 operation(s) for diagnostics.

GitHub OpenAPI

Operations 4

GET /diagnostics/config Get maintainer diagnostics reporting settings #
POST /diagnostics/ingest Ingest a cross-instance diagnostic report #
GET /diagnostics/public-config Get maintainer diagnostics reporting switch #
POST /diagnostics/report Submit a sanitized diagnostic report to this instance #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/openpo-st:openpo-st-diagnostics-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openpo-st-diagnostics-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    email: hello@openpo.st
    name: OpenPost support
    url: https://openpo.st/contact
  description: OpenPost HTTP API for workspace-scoped social publishing. Use it to inspect accounts and provider readiness, manage media and publications, schedule work, and read publishing results. Every operation still follows token scopes, workspace roles, plan limits, provider capabilities, and destination validation.
  license:
    identifier: AGPL-3.0-only
    name: AGPL-3.0-only
  termsOfService: https://openpo.st/terms
  title: OpenPost Diagnostics API
  version: 1.0.0
servers:
- description: OpenPost Hosted service
  url: https://app.openpo.st/api/v1
- description: The OpenPost instance serving this contract
  url: /api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Diagnostics
paths:
  /diagnostics/config:
    get:
      description: Whether this instance sends privacy-limited diagnostic reports to OpenPost. No receiver URL, token, or installation identifier is exposed.
      operationId: get-diagnostics-config
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Get maintainer diagnostics reporting settings
      tags:
      - Diagnostics
  /diagnostics/ingest:
    post:
      description: Public receiver for privacy-limited diagnostic reports sent by OpenPost instances. Strictly validated and quota-limited; accepted reports are forwarded to the maintainer channel.
      operationId: ingest-diagnostics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestDiagnosticsInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestDiagnosticsOutputBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: Ingest a cross-instance diagnostic report
      tags:
      - Diagnostics
  /diagnostics/public-config:
    get:
      description: Whether this instance sends privacy-limited diagnostic reports to OpenPost. Browser reports always go through their own instance.
      operationId: get-diagnostics-public-config
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Get maintainer diagnostics reporting switch
      tags:
      - Diagnostics
  /diagnostics/report:
    post:
      description: Only the allowlisted diagnostic envelope is accepted. User content, credentials, and request bodies are rejected during validation.
      operationId: submit-diagnostics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitDiagnosticsInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitDiagnosticsOutputBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Submit a sanitized diagnostic report to this instance
      tags:
      - Diagnostics
components:
  schemas:
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
    Status:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/Status.json
          format: uri
          readOnly: true
          type: string
        enabled:
          type: boolean
        revision:
          type: string
        version:
          type: string
      required:
      - enabled
      - version
      - revision
      type: object
    IngestDiagnosticsInputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/IngestDiagnosticsInputBody.json
          format: uri
          readOnly: true
          type: string
        attempt_count:
          description: Attempt count, when relevant
          format: int64
          maximum: 1000000
          minimum: 0
          type: integer
        db_driver:
          description: Normalized database driver
          maxLength: 16
          type: string
        error_code:
          description: Normalized error code from the diagnostics catalog
          maxLength: 64
          type: string
        error_kind:
          description: Allowlisted error type, never message text
          enum:
          - 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
          type: string
        first_seen:
          description: RFC3339 first observation, when known
          maxLength: 32
          type: string
        frames:
          description: Sanitized stack frames without domains or local paths
          items:
            $ref: '#/components/schemas/DiagnosticsFrame'
          maxItems: 24
          type:
          - array
          - 'null'
        http_method:
          description: HTTP request method, when relevant
          enum:
          - GET
          - HEAD
          - POST
          - PUT
          - PATCH
          - DELETE
          - OPTIONS
          - CONNECT
          - TRACE
          type: string
        http_status:
          description: HTTP status, when relevant
          format: int64
          maximum: 599
          minimum: 0
          type: integer
        installation_id:
          description: Random installation ID generated by the sending instance
          maxLength: 64
          type: string
        last_seen:
          description: RFC3339 last observation, when known
          maxLength: 32
          type: string
        occurrence_count:
          description: Aggregated occurrence count
          format: int64
          maximum: 1000000
          minimum: 0
          type: integer
        operation:
          description: Route template, job type, or operation name
          maxLength: 160
          type: string
        provider:
          description: First-party platform, when relevant
          maxLength: 32
          type: string
        retry_count:
          description: Retry count, when relevant
          format: int64
          maximum: 1000000
          minimum: 0
          type: integer
        revision:
          description: OpenPost source revision reported by the sending instance
          maxLength: 128
          type: string
        storage_driver:
          description: Normalized media storage driver
          maxLength: 16
          type: string
        surface:
          description: Surface where the failure was observed
          enum:
          - browser
          - backend
          - worker
          type: string
        version:
          description: OpenPost release reported by the sending instance
          maxLength: 64
          type: string
      required:
      - installation_id
      - version
      - revision
      - surface
      - operation
      - error_code
      type: object
    DiagnosticsFrame:
      additionalProperties: false
      properties:
        column:
          description: Source column, when available
          format: int64
          maximum: 1073741824
          minimum: 0
          type: integer
        function:
          description: Function name
          maxLength: 160
          type: string
        line:
          description: Source line
          format: int64
          minimum: 0
          type: integer
        module:
          description: Normalized module path and file, never a URL or domain
          maxLength: 240
          type: string
      required:
      - module
      - function
      - line
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    SubmitDiagnosticsOutputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/SubmitDiagnosticsOutputBody.json
          format: uri
          readOnly: true
          type: string
        accepted:
          type: boolean
        enabled:
          type: boolean
      required:
      - accepted
      - enabled
      type: object
    IngestDiagnosticsOutputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/IngestDiagnosticsOutputBody.json
          format: uri
          readOnly: true
          type: string
        accepted:
          type: boolean
      required:
      - accepted
      type: object
    SubmitDiagnosticsInputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/SubmitDiagnosticsInputBody.json
          format: uri
          readOnly: true
          type: string
        attempt_count:
          description: Attempt count, when relevant
          format: int64
          minimum: 0
          type: integer
        error_code:
          description: Normalized error code from the diagnostics catalog
          maxLength: 64
          type: string
        error_kind:
          description: Allowlisted error type, never message text
          enum:
          - 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
          type: string
        frames:
          description: Sanitized stack frames without domains or local paths
          items:
            $ref: '#/components/schemas/DiagnosticsFrame'
          maxItems: 24
          type:
          - array
          - 'null'
        http_method:
          description: HTTP request method, when relevant
          enum:
          - GET
          - HEAD
          - POST
          - PUT
          - PATCH
          - DELETE
          - OPTIONS
          - CONNECT
          - TRACE
          type: string
        http_status:
          description: HTTP status, when relevant
          format: int64
          maximum: 599
          minimum: 0
          type: integer
        operation:
          description: Route template, job type, or operation name
          maxLength: 160
          type: string
        provider:
          description: First-party platform, when relevant
          maxLength: 32
          type: string
        retry_count:
          description: Retry count, when relevant
          format: int64
          minimum: 0
          type: integer
        surface:
          description: Surface where the failure was observed
          enum:
          - browser
          - backend
          - worker
          type: string
      required:
      - surface
      - operation
      - error_code
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: OpenPost API token or session JWT
      scheme: bearer
      type: http
    sessionCookie:
      in: cookie
      name: openpost_session
      type: apiKey