API Endpoint Reference / Printers
Read printer material slots and their source and nozzle layout
GET https://api.printhiv3d.com/v1/printers/{id}/material-slots/layout
Operation ID readPrinterMaterialLayout. Requires the read API key scope.
Requires an organization API key with read scope or an authenticated organization session. Host credentials are rejected, including Host-bound wildcard keys. Legacy unbound wildcard keys are accepted.
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | uuid | Yes | |
Responses
| Status | Description |
|---|
200 | Default Response |
400 | Default Response |
401 | Default Response |
403 | Default Response |
404 | Default Response |
409 | Default Response |
422 | Default Response |
500 | Default Response |
503 | Default Response |
200 response fields
| Field | Type | Required | Description |
|---|
printer | object | Yes | |
topology | object | Yes | |
freshness | object | Yes | |
nozzles | object[] | Yes | |
unboundSources | object[] | Yes | |
unmappedAssignments | object[] | Yes | |
hotendRack | object | Yes | |
400 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
401 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
403 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
404 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
409 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
422 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
500 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
503 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
Example 200 response
{
"printer": {
"id": "7d3f1c2a-5b8e-4f6a-9c1d-2e4b6a8c0f13",
"name": "Bay 3",
"make": "Bambu Lab",
"model": "P1S",
"modelId": "bambu-p1s",
"family": "bambu",
"connected": false
},
"topology": {
"kind": "unavailable",
"reason": "topology_not_reported"
},
"freshness": {
"status": "unavailable",
"reason": "printer_offline"
},
"nozzles": [],
"unboundSources": [],
"unmappedAssignments": [],
"hotendRack": {
"kind": "no-rack-reported"
}
}