Plugin API Error Codes¶

Overview¶

There are two layers of errors when using Plugin APIs. Any Plugin API call can fail at either layer, so clients should handle both the HTTP response status and any plugin Status value in a JSON response.

First, your request must be validated and processed by the OctoEverywhere service, then by the OctoEverywhere plugin, and finally by your 3D printer's host software. Errors can come from any of those hops.

OctoEverywhere Service Errors¶

These are 600 level HTTP error codes that are generated by the OctoEverywhere service for issues communicating with the plugin. For example, if the plugin is not connected to OctoEverywhere and is offline.

See OctoEverywhere API Error Codes

Plugin API Errors¶

Most command endpoints return HTTP 200 after the request reaches the plugin, with the command outcome in the JSON body's Status field.

{
    "Status": 785,
    "Error": "Host not connected"
}

The plugin Status can be a common 700-level command code or a command-specific 400- or 500-level value. These are not necessarily the HTTP response status.

Raw-response endpoints are the exception. Webcam snapshots and streams, file downloads, and plugin-log downloads return their content directly and can use actual non-200 HTTP statuses. For example, a missing file download or plugin log can return HTTP 404 with a JSON error body.

Plugin API Common Error Codes¶

Plugin API Specific Errors¶

Each Plugin API can return different error codes, which are documented with each API definition on this site.