OctoPrint · JSON-LD Context

Octoprint Context

JSON-LD context defining the semantic vocabulary for Octoprint from OctoPrint.

67 Classes 132 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
octoprint: https://octoprint.org/schema#

Classes

GetApiAccessGroupsResponse PostApiAccessGroupsRequest PostApiAccessGroupsResponse GetApiAccessPermissionsResponse GetApiAccessUsersResponse PostApiAccessUsersRequest PostApiAccessUsersResponse GetApiConnectionResponse PostApiConnectionRequest GetApiCurrentuserResponse GetApiFilesResponse PostApiFilesRequest PostApiFilesResponse GetApiFilesLocalResponse PostApiFilesLocalRequest PostApiFilesLocalResponse PostApiFilesLocalSomeFolderAndASubfolderRequest PostApiFilesLocalSomeFolderAndASubfolderResponse PostApiFilesLocalSomeFolderSomeModelGcodeRequest PostApiFilesLocalSomeFolderSomeModelGcodeResponse PostApiFilesLocalSomeFolderSomeModelStlRequest PostApiFilesLocalSomeFolderSomeModelStlResponse GetApiFilesLocalWhistleV2GcodeResponse PostApiFilesLocalWhistleV2GcodeRequest PostApiFilesSdcardRequest PostApiFilesSdcardResponse GetApiJobResponse PostApiJobRequest GetApiLanguagesResponse PostApiLanguagesRequest PostApiLanguagesResponse PostApiLoginRequest PostApiLoginResponse PostApiPluginMysimpleapipluginRequest PostApiPluginMysimpleapipluginResponse GetApiPrinterResponse GetApiPrinterBedResponse PostApiPrinterBedRequest GetApiPrinterChamberResponse PostApiPrinterChamberRequest PostApiPrinterCommandRequest GetApiPrinterCommandCustomResponse GetApiPrinterErrorResponse PostApiPrinterPrintheadRequest GetApiPrinterSdResponse PostApiPrinterSdRequest GetApiPrinterToolResponse PostApiPrinterToolRequest GetApiPrinterprofilesResponse PostApiPrinterprofilesRequest PostApiPrinterprofilesResponse GetApiServerResponse GetApiSettingsResponse PostApiSettingsRequest PostApiSettingsResponse PostApiSettingsApikeyResponse GetApiSettingsTemplatesResponse GetApiSlicingResponse GetApiSystemCommandsResponse GetApiTimelapseResponse PostApiTimelapseRequest PostApiTimelapseResponse PostApiUtilTestRequest PostApiUtilTestResponse GetApiVersionResponse GetSetupWizardResponse PostSetupWizardRequest

Properties

Property Type Container
groups list
key string
name string
description string
permissions list
subgroups list
default boolean
users list
password string
active boolean
admin boolean
current
current.state string
current.port string
current.baudrate decimal
current.printerProfile string
options
options.ports list
options.baudrates list
options.printerProfiles list
options.portPreference string
options.baudratePreference decimal
options.printerProfilePreference string
options.autoconnect boolean
command string
port string
baudrate decimal
printerProfile string
save boolean
autoconnect boolean
files list
free string
file string
foldername string
path string
select boolean
print boolean
userdata string
done boolean
effectiveSelect boolean
effectivePrint boolean
destination string
origin string
refs
slicer string
gcode string
profile string
position
size integer
date integer
gcodeAnalysis
job string
progress string
state string
error string
action string
language_packs string
passive boolean
user string
pass string
remember boolean
session string
_is_external_client boolean
data
response
temperature string
sd string
bed string
history list
target
offset
chamber string
commands string
controls list
reason string
consequence string
faq string
logs list
x decimal
y decimal
z decimal
axes list
factor decimal
ready boolean
targets
offsets
tool
amount
profiles
basedOn string
version string
safemode string
api string
appearance string
settings string
apikey string
order string
core list
custom list
config string
unrendered list
type string
check_type string
check_access list
allow_create_dir boolean
check_writable_dir boolean
url string
status string
method string
timeout decimal
validSsl boolean
basicAuth
digestAuth
bearerAuth string
content_type_whitelist list
content_type_blacklist list
host string
protocol string
address string
exists boolean
typeok boolean
access boolean
result boolean
headers
is_lan_address boolean
subnet string
server string
text string
required boolean
details
ignored boolean
handled string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://octoprint.org/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "octoprint": "https://octoprint.org/schema#",
    "GetApiAccessGroupsResponse": "octoprint:GetApiAccessGroupsResponse",
    "groups": {
      "@id": "octoprint:groups",
      "@container": "@list"
    },
    "PostApiAccessGroupsRequest": "octoprint:PostApiAccessGroupsRequest",
    "key": {
      "@id": "octoprint:key",
      "@type": "xsd:string"
    },
    "name": {
      "@id": "octoprint:name",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "octoprint:description",
      "@type": "xsd:string"
    },
    "permissions": {
      "@id": "octoprint:permissions",
      "@container": "@list"
    },
    "subgroups": {
      "@id": "octoprint:subgroups",
      "@container": "@list"
    },
    "default": {
      "@id": "octoprint:default",
      "@type": "xsd:boolean"
    },
    "PostApiAccessGroupsResponse": "octoprint:PostApiAccessGroupsResponse",
    "GetApiAccessPermissionsResponse": "octoprint:GetApiAccessPermissionsResponse",
    "GetApiAccessUsersResponse": "octoprint:GetApiAccessUsersResponse",
    "users": {
      "@id": "octoprint:users",
      "@container": "@list"
    },
    "PostApiAccessUsersRequest": "octoprint:PostApiAccessUsersRequest",
    "password": {
      "@id": "octoprint:password",
      "@type": "xsd:string"
    },
    "active": {
      "@id": "octoprint:active",
      "@type": "xsd:boolean"
    },
    "admin": {
      "@id": "octoprint:admin",
      "@type": "xsd:boolean"
    },
    "PostApiAccessUsersResponse": "octoprint:PostApiAccessUsersResponse",
    "GetApiConnectionResponse": "octoprint:GetApiConnectionResponse",
    "current": {
      "@id": "octoprint:current"
    },
    "current.state": {
      "@id": "octoprint:current.state",
      "@type": "xsd:string"
    },
    "current.port": {
      "@id": "octoprint:current.port",
      "@type": "xsd:string"
    },
    "current.baudrate": {
      "@id": "octoprint:current.baudrate",
      "@type": "xsd:decimal"
    },
    "current.printerProfile": {
      "@id": "octoprint:current.printerProfile",
      "@type": "xsd:string"
    },
    "options": {
      "@id": "octoprint:options"
    },
    "options.ports": {
      "@id": "octoprint:options.ports",
      "@container": "@list"
    },
    "options.baudrates": {
      "@id": "octoprint:options.baudrates",
      "@container": "@list"
    },
    "options.printerProfiles": {
      "@id": "octoprint:options.printerProfiles",
      "@container": "@list"
    },
    "options.portPreference": {
      "@id": "octoprint:options.portPreference",
      "@type": "xsd:string"
    },
    "options.baudratePreference": {
      "@id": "octoprint:options.baudratePreference",
      "@type": "xsd:decimal"
    },
    "options.printerProfilePreference": {
      "@id": "octoprint:options.printerProfilePreference",
      "@type": "xsd:string"
    },
    "options.autoconnect": {
      "@id": "octoprint:options.autoconnect",
      "@type": "xsd:boolean"
    },
    "PostApiConnectionRequest": "octoprint:PostApiConnectionRequest",
    "command": {
      "@id": "octoprint:command",
      "@type": "xsd:string"
    },
    "port": {
      "@id": "octoprint:port",
      "@type": "xsd:string"
    },
    "baudrate": {
      "@id": "octoprint:baudrate",
      "@type": "xsd:decimal"
    },
    "printerProfile": {
      "@id": "octoprint:printerProfile",
      "@type": "xsd:string"
    },
    "save": {
      "@id": "octoprint:save",
      "@type": "xsd:boolean"
    },
    "autoconnect": {
      "@id": "octoprint:autoconnect",
      "@type": "xsd:boolean"
    },
    "GetApiCurrentuserResponse": "octoprint:GetApiCurrentuserResponse",
    "GetApiFilesResponse": "octoprint:GetApiFilesResponse",
    "files": {
      "@id": "octoprint:files",
      "@container": "@list"
    },
    "free": {
      "@id": "octoprint:free",
      "@type": "xsd:string"
    },
    "PostApiFilesRequest": "octoprint:PostApiFilesRequest",
    "file": {
      "@id": "octoprint:file",
      "@type": "xsd:string"
    },
    "foldername": {
      "@id": "octoprint:foldername",
      "@type": "xsd:string"
    },
    "path": {
      "@id": "octoprint:path",
      "@type": "xsd:string"
    },
    "select": {
      "@id": "octoprint:select",
      "@type": "xsd:boolean"
    },
    "print": {
      "@id": "octoprint:print",
      "@type": "xsd:boolean"
    },
    "userdata": {
      "@id": "octoprint:userdata",
      "@type": "xsd:string"
    },
    "PostApiFilesResponse": "octoprint:PostApiFilesResponse",
    "done": {
      "@id": "octoprint:done",
      "@type": "xsd:boolean"
    },
    "effectiveSelect": {
      "@id": "octoprint:effectiveSelect",
      "@type": "xsd:boolean"
    },
    "effectivePrint": {
      "@id": "octoprint:effectivePrint",
      "@type": "xsd:boolean"
    },
    "GetApiFilesLocalResponse": "octoprint:GetApiFilesLocalResponse",
    "PostApiFilesLocalRequest": "octoprint:PostApiFilesLocalRequest",
    "PostApiFilesLocalResponse": "octoprint:PostApiFilesLocalResponse",
    "PostApiFilesLocalSomeFolderAndASubfolderRequest": "octoprint:PostApiFilesLocalSomeFolderAndASubfolderRequest",
    "destination": {
      "@id": "octoprint:destination",
      "@type": "xsd:string"
    },
    "PostApiFilesLocalSomeFolderAndASubfolderResponse": "octoprint:PostApiFilesLocalSomeFolderAndASubfolderResponse",
    "origin": {
      "@id": "octoprint:origin",
      "@type": "xsd:string"
    },
    "refs": {
      "@id": "octoprint:refs"
    },
    "PostApiFilesLocalSomeFolderSomeModelGcodeRequest": "octoprint:PostApiFilesLocalSomeFolderSomeModelGcodeRequest",
    "PostApiFilesLocalSomeFolderSomeModelGcodeResponse": "octoprint:PostApiFilesLocalSomeFolderSomeModelGcodeResponse",
    "PostApiFilesLocalSomeFolderSomeModelStlRequest": "octoprint:PostApiFilesLocalSomeFolderSomeModelStlRequest",
    "slicer": {
      "@id": "octoprint:slicer",
      "@type": "xsd:string"
    },
    "gcode": {
      "@id": "octoprint:gcode",
      "@type": "xsd:string"
    },
    "profile": {
      "@id": "octoprint:profile",
      "@type": "xsd:string"
    },
    "position": {
      "@id": "octoprint:position"
    },
    "PostApiFilesLocalSomeFolderSomeModelStlResponse": "octoprint:PostApiFilesLocalSomeFolderSomeModelStlResponse",
    "GetApiFilesLocalWhistleV2GcodeResponse": "octoprint:GetApiFilesLocalWhistleV2GcodeResponse",
    "size": {
      "@id": "octoprint:size",
      "@type": "xsd:integer"
    },
    "date": {
      "@id": "octoprint:date",
      "@type": "xsd:integer"
    },
    "gcodeAnalysis": {
      "@id": "octoprint:gcodeAnalysis"
    },
    "PostApiFilesLocalWhistleV2GcodeRequest": "octoprint:PostApiFilesLocalWhistleV2GcodeRequest",
    "PostApiFilesSdcardRequest": "octoprint:PostApiFilesSdcardRequest",
    "PostApiFilesSdcardResponse": "octoprint:PostApiFilesSdcardResponse",
    "GetApiJobResponse": "octoprint:GetApiJobResponse",
    "job": {
      "@id": "octoprint:job",
      "@type": "xsd:string"
    },
    "progress": {
      "@id": "octoprint:progress",
      "@type": "xsd:string"
    },
    "state": {
      "@id": "octoprint:state",
      "@type": "xsd:string"
    },
    "error": {
      "@id": "octoprint:error",
      "@type": "xsd:string"
    },
    "PostApiJobRequest": "octoprint:PostApiJobRequest",
    "action": {
      "@id": "octoprint:action",
      "@type": "xsd:string"
    },
    "GetApiLanguagesResponse": "octoprint:GetApiLanguagesResponse",
    "language_packs": {
      "@id": "octoprint:language_packs",
      "@type": "xsd:string"
    },
    "PostApiLanguagesRequest": "octoprint:PostApiLanguagesRequest",
    "PostApiLanguagesResponse": "octoprint:PostApiLanguagesResponse",
    "PostApiLoginRequest": "octoprint:PostApiLoginRequest",
    "passive": {
      "@id": "octoprint:passive",
      "@type": "xsd:boolean"
    },
    "user": {
      "@id": "octoprint:user",
      "@type": "xsd:string"
    },
    "pass": {
      "@id": "octoprint:pass",
      "@type": "xsd:string"
    },
    "remember": {
      "@id": "octoprint:remember",
      "@type": "xsd:boolean"
    },
    "PostApiLoginResponse": "octoprint:PostApiLoginResponse",
    "session": {
      "@id": "octoprint:session",
      "@type": "xsd:string"
    },
    "_is_external_client": {
      "@id": "octoprint:_is_external_client",
      "@type": "xsd:boolean"
    },
    "PostApiPluginMysimpleapipluginRequest": "octoprint:PostApiPluginMysimpleapipluginRequest",
    "data": {
      "@id": "octoprint:data"
    },
    "PostApiPluginMysimpleapipluginResponse": "octoprint:PostApiPluginMysimpleapipluginResponse",
    "response": {
      "@id": "octoprint:response"
    },
    "GetApiPrinterResponse": "octoprint:GetApiPrinterResponse",
    "temperature": {
      "@id": "octoprint:temperature",
      "@type": "xsd:string"
    },
    "sd": {
      "@id": "octoprint:sd",
      "@type": "xsd:string"
    },
    "GetApiPrinterBedResponse": "octoprint:GetApiPrinterBedResponse",
    "bed": {
      "@id": "octoprint:bed",
      "@type": "xsd:string"
    },
    "history": {
      "@id": "octoprint:history",
      "@container": "@list"
    },
    "PostApiPrinterBedRequest": "octoprint:PostApiPrinterBedRequest",
    "target": {
      "@id": "octoprint:target"
    },
    "offset": {
      "@id": "octoprint:offset"
    },
    "GetApiPrinterChamberResponse": "octoprint:GetApiPrinterChamberResponse",
    "chamber": {
      "@id": "octoprint:chamber",
      "@type": "xsd:string"
    },
    "PostApiPrinterChamberRequest": "octoprint:PostApiPrinterChamberRequest",
    "PostApiPrinterCommandRequest": "octoprint:PostApiPrinterCommandRequest",
    "commands": {
      "@id": "octoprint:commands",
      "@type": "xsd:string"
    },
    "GetApiPrinterCommandCustomResponse": "octoprint:GetApiPrinterCommandCustomResponse",
    "controls": {
      "@id": "octoprint:controls",
      "@container": "@list"
    },
    "GetApiPrinterErrorResponse": "octoprint:GetApiPrinterErrorResponse",
    "reason": {
      "@id": "octoprint:reason",
      "@type": "xsd:string"
    },
    "consequence": {
      "@id": "octoprint:consequence",
      "@type": "xsd:string"
    },
    "faq": {
      "@id": "octoprint:faq",
      "@type": "xsd:string"
    },
    "logs": {
      "@id": "octoprint:logs",
      "@container": "@list"
    },
    "PostApiPrinterPrintheadRequest": "octoprint:PostApiPrinterPrintheadRequest",
    "x": {
      "@id": "octoprint:x",
      "@type": "xsd:decimal"
    },
    "y": {
      "@id": "octoprint:y",
      "@type": "xsd:decimal"
    },
    "z": {
      "@id": "octoprint:z",
      "@type": "xsd:decimal"
    },
    "axes": {
      "@id": "octoprint:axes",
      "@container": "@list"
    },
    "factor": {
      "@id": "octoprint:factor",
      "@type": "xsd:decimal"
    },
    "GetApiPrinterSdResponse": "octoprint:GetApiPrinterSdResponse",
    "ready": {
      "@id": "octoprint:ready",
      "@type": "xsd:boolean"
    },
    "PostApiPrinterSdRequest": "octoprint:PostApiPrinterSdRequest",
    "GetApiPrinterToolResponse": "octoprint:GetApiPrinterToolResponse",
    "PostApiPrinterToolRequest": "octoprint:PostApiPrinterToolRequest",
    "targets": {
      "@id": "octoprint:targets"
    },
    "offsets": {
      "@id": "octoprint:offsets"
    },
    "tool": {
      "@id": "octoprint:tool"
    },
    "amount": {
      "@id": "octoprint:amount"
    },
    "GetApiPrinterprofilesResponse": "octoprint:GetApiPrinterprofilesResponse",
    "profiles": {
      "@id": "octoprint:profiles"
    },
    "PostApiPrinterprofilesRequest": "octoprint:PostApiPrinterprofilesRequest",
    "basedOn": {
      "@id": "octoprint:basedOn",
      "@type": "xsd:string"
    },
    "PostApiPrinterprofilesResponse": "octoprint:PostApiPrinterprofilesResponse",
    "GetApiServerResponse": "octoprint:GetApiServerResponse",
    "version": {
      "@id": "octoprint:version",
      "@type": "xsd:string"
    },
    "safemode": {
      "@id": "octoprint:safemode",
      "@type": "xsd:string"
    },
    "GetApiSettingsResponse": "octoprint:GetApiSettingsResponse",
    "api": {
      "@id": "octoprint:api",
      "@type": "xsd:string"
    },
    "appearance": {
      "@id": "octoprint:appearance",
      "@type": "xsd:string"
    },
    "PostApiSettingsRequest": "octoprint:PostApiSettingsRequest",
    "settings": {
      "@id": "octoprint:settings",
      "@type": "xsd:string"
    },
    "PostApiSettingsResponse": "octoprint:PostApiSettingsResponse",
    "PostApiSettingsApikeyResponse": "octoprint:PostApiSettingsApikeyResponse",
    "apikey": {
      "@id": "octoprint:apikey",
      "@type": "xsd:string"
    },
    "GetApiSettingsTemplatesResponse": "octoprint:GetApiSettingsTemplatesResponse",
    "order": {
      "@id": "octoprint:order",
      "@type": "xsd:string"
    },
    "GetApiSlicingResponse": "octoprint:GetApiSlicingResponse",
    "GetApiSystemCommandsResponse": "octoprint:GetApiSystemCommandsResponse",
    "core": {
      "@id": "octoprint:core",
      "@container": "@list"
    },
    "custom": {
      "@id": "octoprint:custom",
      "@container": "@list"
    },
    "GetApiTimelapseResponse": "octoprint:GetApiTimelapseResponse",
    "config": {
      "@id": "octoprint:config",
      "@type": "xsd:string"
    },
    "unrendered": {
      "@id": "octoprint:unrendered",
      "@container": "@list"
    },
    "PostApiTimelapseRequest": "octoprint:PostApiTimelapseRequest",
    "type": {
      "@id": "octoprint:type",
      "@type": "xsd:string"
    },
    "PostApiTimelapseResponse": "octoprint:PostApiTimelapseResponse",
    "PostApiUtilTestRequest": "octoprint:PostApiUtilTestRequest",
    "check_type": {
      "@id": "octoprint:check_type",
      "@type": "xsd:string"
    },
    "check_access": {
      "@id": "octoprint:check_access",
      "@container": "@list"
    },
    "allow_create_dir": {
      "@id": "octoprint:allow_create_dir",
      "@type": "xsd:boolean"
    },
    "check_writable_dir": {
      "@id": "octoprint:check_writable_dir",
      "@type": "xsd:boolean"
    },
    "url": {
      "@id": "octoprint:url",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "octoprint:status",
      "@type": "xsd:string"
    },
    "method": {
      "@id": "octoprint:method",
      "@type": "xsd:string"
    },
    "timeout": {
      "@id": "octoprint:timeout",
      "@type": "xsd:decimal"
    },
    "validSsl": {
      "@id": "octoprint:validSsl",
      "@type": "xsd:boolean"
    },
    "basicAuth": {
      "@id": "octoprint:basicAuth"
    },
    "digestAuth": {
      "@id": "octoprint:digestAuth"
    },
    "bearerAuth": {
      "@id": "octoprint:bearerAuth",
      "@type": "xsd:string"
    },
    "content_type_whitelist": {
      "@id": "octoprint:content_type_whitelist",
      "@container": "@list"
    },
    "content_type_blacklist": {
      "@id": "octoprint:content_type_blacklist",
      "@container": "@list"
    },
    "host": {
      "@id": "octoprint:host",
      "@type": "xsd:string"
    },
    "protocol": {
      "@id": "octoprint:protocol",
      "@type": "xsd:string"
    },
    "address": {
      "@id": "octoprint:address",
      "@type": "xsd:string"
    },
    "PostApiUtilTestResponse": "octoprint:PostApiUtilTestResponse",
    "exists": {
      "@id": "octoprint:exists",
      "@type": "xsd:boolean"
    },
    "typeok": {
      "@id": "octoprint:typeok",
      "@type": "xsd:boolean"
    },
    "access": {
      "@id": "octoprint:access",
      "@type": "xsd:boolean"
    },
    "result": {
      "@id": "octoprint:result",
      "@type": "xsd:boolean"
    },
    "headers": {
      "@id": "octoprint:headers"
    },
    "is_lan_address": {
      "@id": "octoprint:is_lan_address",
      "@type": "xsd:boolean"
    },
    "subnet": {
      "@id": "octoprint:subnet",
      "@type": "xsd:string"
    },
    "GetApiVersionResponse": "octoprint:GetApiVersionResponse",
    "server": {
      "@id": "octoprint:server",
      "@type": "xsd:string"
    },
    "text": {
      "@id": "octoprint:text",
      "@type": "xsd:string"
    },
    "GetSetupWizardResponse": "octoprint:GetSetupWizardResponse",
    "required": {
      "@id": "octoprint:required",
      "@type": "xsd:boolean"
    },
    "details": {
      "@id": "octoprint:details"
    },
    "ignored": {
      "@id": "octoprint:ignored",
      "@type": "xsd:boolean"
    },
    "PostSetupWizardRequest": "octoprint:PostSetupWizardRequest",
    "handled": {
      "@id": "octoprint:handled",
      "@type": "xsd:string"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "OctoPrint API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects OctoPrint's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-28) from openapi/_ae-authored/octoprint-openapi-generated.yml.",
  "dcterms:created": "2026-10-28",
  "dcterms:source": [
    "openapi/_ae-authored/octoprint-openapi-generated.yml"
  ]
}