mirror of
https://github.com/gosticks/octoprint-open-api.git
synced 2025-10-16 11:45:38 +00:00
26 lines
718 B
YAML
26 lines
718 B
YAML
summary: Printer State
|
|
description: Retrieves the current state of the printer.
|
|
operationId: getPrinterState
|
|
tags:
|
|
- State
|
|
parameters:
|
|
- $ref: ../../components/parameters/history.yaml
|
|
- $ref: ../../components/parameters/limit.yaml
|
|
- in: query
|
|
name: exclude
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- temperature
|
|
- sd
|
|
- state
|
|
description: >-
|
|
An optional comma-separated list of fields to exclude from the response (e.g. if not needed by the client). Valid values to supply here are temperature, sd and state.
|
|
responses:
|
|
"200":
|
|
description: Current Printer state.
|
|
"409":
|
|
description: If the printer is not operational.
|