The External Machine Management section of the InvenTree API schema is documented below.
InvenTree API 196¶
API for InvenTree - the intuitive open source inventory management system
Servers¶
Description | URL |
---|---|
http://localhost:8000 | http://localhost:8000 |
machine¶
GET /api/machine/¶
Description
API endpoint for list of Machine objects.
- GET: Return a list of all Machine objects
- POST: create a MachineConfig
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
active |
query | boolean | No | ||
driver |
query | string | No | ||
limit |
query | integer | No | Number of results to return per page. | |
machine_type |
query | string | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "3bba9218-5967-464e-81fb-5ba4aae8067d",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/MachineConfig"
},
"type": "array"
}
},
"type": "object"
}
POST /api/machine/¶
Description
API endpoint for list of Machine objects.
- GET: Return a list of all Machine objects
- POST: create a MachineConfig
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "3cfcc845-6464-410d-8923-8c5bf699e1fb",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for creating a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"maxLength": 255,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"maxLength": 255,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "dda0d4bf-5f9e-4a40-808e-bcb5c034d218",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for creating a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"maxLength": 255,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"maxLength": 255,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "95a3f65c-79aa-47ac-b608-2e8c0eda1f56",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for creating a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"maxLength": 255,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"maxLength": 255,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
Response 201 Created
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "2e3806f1-29b2-4a69-9c82-30e2362bc8bc",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the response body
{
"description": "Serializer for creating a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"maxLength": 255,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"maxLength": 255,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
GET /api/machine/drivers/¶
Description
List all machine drivers.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
[
{
"description": "string",
"driver_errors": [
"string"
],
"is_builtin": true,
"machine_type": "string",
"name": "string",
"provider_file": "string",
"provider_plugin": {},
"slug": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/MachineDriver"
},
"type": "array"
}
GET /api/machine/status/¶
Description
Provide status data for the machine registry.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"registry_errors": [
{
"message": "string"
}
]
}
Schema of the response body
{
"description": "Serializer for machine registry status.",
"properties": {
"registry_errors": {
"items": {
"$ref": "#/components/schemas/MachineRegistryError"
},
"type": "array"
}
},
"required": [
"registry_errors"
],
"type": "object"
}
GET /api/machine/types/¶
Description
List all machine types.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
[
{
"description": "string",
"is_builtin": true,
"name": "string",
"provider_file": "string",
"provider_plugin": {},
"slug": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/MachineType"
},
"type": "array"
}
DELETE /api/machine/{id}/¶
Description
API detail endpoint for MachineConfig object.
- GET: return a single MachineConfig
- PUT: update a MachineConfig
- PATCH: partial update a MachineConfig
- DELETE: delete a MachineConfig
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Response 204 No Content
GET /api/machine/{id}/¶
Description
API detail endpoint for MachineConfig object.
- GET: return a single MachineConfig
- PUT: update a MachineConfig
- PATCH: partial update a MachineConfig
- DELETE: delete a MachineConfig
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Response 200 OK
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "4911feb0-c445-49c5-ae72-04307f8f1f42",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the response body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
PATCH /api/machine/{id}/¶
Description
API detail endpoint for MachineConfig object.
- GET: return a single MachineConfig
- PUT: update a MachineConfig
- PATCH: partial update a MachineConfig
- DELETE: delete a MachineConfig
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Request body
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "f1673a80-83b5-45e1-84bf-8a5d2c76fef1",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "cd92a83c-df73-4120-a2e2-008bbff91e00",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "8b1a9ecc-a5d3-4bb4-93ee-71ddfe2b9601",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "c686decd-e86d-4dd9-bee4-ee807d3f5b4c",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the response body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
PUT /api/machine/{id}/¶
Description
API detail endpoint for MachineConfig object.
- GET: return a single MachineConfig
- PUT: update a MachineConfig
- PATCH: partial update a MachineConfig
- DELETE: delete a MachineConfig
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Request body
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "c4a4b1ad-66ca-4aaa-ab4c-465c4a227483",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "41c1b32e-9652-46d2-a92b-8eb8b56e7f0c",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "efc5d1ac-0fb9-42ae-be3f-0d7ffac4d45b",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the request body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
Response 200 OK
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "ca24b954-1cba-4a3f-9c89-c11bacb1d616",
"restart_required": true,
"status": 0,
"status_model": "string",
"status_text": "string"
}
Schema of the response body
{
"description": "Serializer for a MachineConfig.",
"properties": {
"active": {
"description": "Machines can be disabled",
"type": "boolean"
},
"driver": {
"description": "Driver used for the machine",
"readOnly": true,
"type": "string"
},
"initialized": {
"description": "Serializer method for the initialized field.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Serializer method for the is_driver_available field.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "Serializer method for the errors field.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"machine_type": {
"description": "Type of machine",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of machine",
"maxLength": 255,
"type": "string"
},
"pk": {
"format": "uuid",
"readOnly": true,
"title": "Id",
"type": "string"
},
"restart_required": {
"description": "Serializer method for the restart_required field.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Serializer method for the status field.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Serializer method for the status model field.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Serializer method for the status text field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"restart_required",
"status",
"status_model",
"status_text"
],
"type": "object"
}
POST /api/machine/{id}/restart/¶
Description
Restart machine by pk.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Response 200 OK
{
"ok": true
}
Schema of the response body
{
"description": "Serializer for the machine restart response.",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"type": "object"
}
GET /api/machine/{id}/settings/¶
Description
Return all settings for a machine config.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Response 200 OK
[
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/MachineSetting"
},
"type": "array"
}
GET /api/machine/{id}/settings/{config_type}/{key}/¶
Description
Detail endpoint for a machine-specific setting.
- GET: Get machine setting detail
- PUT: Update machine setting
- PATCH: Update machine setting
(Note that these cannot be created or deleted via API)
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
config_type |
path | string | No | ||
id |
path | string | No | ||
key |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"config_type",
"description",
"key",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
PATCH /api/machine/{id}/settings/{config_type}/{key}/¶
Description
Detail endpoint for a machine-specific setting.
- GET: Get machine setting detail
- PUT: Update machine setting
- PATCH: Update machine setting
(Note that these cannot be created or deleted via API)
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
config_type |
path | string | No | ||
id |
path | string | No | ||
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"config_type",
"description",
"key",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
PUT /api/machine/{id}/settings/{config_type}/{key}/¶
Description
Detail endpoint for a machine-specific setting.
- GET: Get machine setting detail
- PUT: Update machine setting
- PATCH: Update machine setting
(Note that these cannot be created or deleted via API)
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
config_type |
path | string | No | ||
id |
path | string | No | ||
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"config_type",
"description",
"key",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"config_type",
"description",
"key",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"config_type",
"description",
"key",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"description": "Returns the choices available for a given item.",
"items": {},
"readOnly": true,
"type": "array"
},
"config_type": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigTypeEnum"
}
],
"readOnly": true
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"config_type",
"description",
"key",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
Schemas¶
ConfigTypeEnum¶
Type: string
MachineConfig¶
Name | Type |
---|---|
active |
boolean |
driver |
string |
initialized |
boolean |
is_driver_available |
boolean |
machine_errors |
Array<string> |
machine_type |
string |
name |
string |
pk |
string(uuid) |
restart_required |
boolean |
status |
integer |
status_model |
string| null |
status_text |
string |
MachineConfigCreate¶
Name | Type |
---|---|
active |
boolean |
driver |
string |
initialized |
boolean |
is_driver_available |
boolean |
machine_errors |
Array<string> |
machine_type |
string |
name |
string |
pk |
string(uuid) |
restart_required |
boolean |
status |
integer |
status_model |
string| null |
status_text |
string |
MachineDriver¶
Name | Type |
---|---|
description |
string |
driver_errors |
Array<string> |
is_builtin |
boolean |
machine_type |
string |
name |
string |
provider_file |
string |
provider_plugin |
|
slug |
string |
MachineRegistryError¶
Name | Type |
---|---|
message |
string |
MachineRegistryStatus¶
Name | Type |
---|---|
registry_errors |
Array<MachineRegistryError> |
MachineRestart¶
Name | Type |
---|---|
ok |
boolean |
MachineSetting¶
Name | Type |
---|---|
api_url |
string |
choices |
Array<> |
config_type |
|
description |
string |
key |
string |
model_name |
string |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
value |
string |
MachineType¶
Name | Type |
---|---|
description |
string |
is_builtin |
boolean |
name |
string |
provider_file |
string |
provider_plugin |
|
slug |
string |
PaginatedMachineConfigList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<MachineConfig> |
PatchedMachineConfig¶
Name | Type |
---|---|
active |
boolean |
driver |
string |
initialized |
boolean |
is_driver_available |
boolean |
machine_errors |
Array<string> |
machine_type |
string |
name |
string |
pk |
string(uuid) |
restart_required |
boolean |
status |
integer |
status_model |
string| null |
status_text |
string |
PatchedMachineSetting¶
Name | Type |
---|---|
api_url |
string |
choices |
Array<> |
config_type |
|
description |
string |
key |
string |
model_name |
string |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
value |
string |
Security schemes¶
Name | Type | Scheme | Description |
---|---|---|---|
basicAuth | http | basic | |
cookieAuth | apiKey | ||
tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs