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

---

License: MIT

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

application/json

{
    "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": "c5bc810d-439f-4252-a9e8-8c5d58e4b058",
            "restart_required": true,
            "status": 0,
            "status_model": "string",
            "status_text": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "a8a8ab43-23e8-4f1b-b4c3-8c4b9de8dc02",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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": "71288854-25ac-476c-9bc2-e0eb0555fa70",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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": "269b3597-ac8b-4686-8d75-48520678ed91",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "34027b5b-6327-4e09-99ee-06e5ab760cbd",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

[
    {
        "description": "string",
        "driver_errors": [
            "string"
        ],
        "is_builtin": true,
        "machine_type": "string",
        "name": "string",
        "provider_file": "string",
        "provider_plugin": {},
        "slug": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "registry_errors": [
        {
            "message": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

[
    {
        "description": "string",
        "is_builtin": true,
        "name": "string",
        "provider_file": "string",
        "provider_plugin": {},
        "slug": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "221c8334-92f6-410e-876d-2e2bb69d5d36",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "f15c6269-8e6f-433a-967c-da51be909222",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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": "06f51143-fe85-44f7-ac81-99e6c9d06257",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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": "72007bd4-b748-4d91-9a5e-541d58ba82b2",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "12a7e8ce-2cb5-4b78-b2ed-5ca77ed6e593",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "a8d3fc97-daa7-44d7-9f70-7825be39a027",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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": "20a75f4a-cb2f-4898-bddf-acd24a791a10",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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": "c4a29753-e371-4655-b125-205edc1c9ea9",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "active": true,
    "driver": "string",
    "initialized": true,
    "is_driver_available": true,
    "machine_errors": [
        "string"
    ],
    "machine_type": "string",
    "name": "string",
    "pk": "7e875f95-b491-4f98-b09c-80fbf0bc10c0",
    "restart_required": true,
    "status": 0,
    "status_model": "string",
    "status_text": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "ok": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

[
    {
        "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"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

application/json

{
    "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"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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

---

For more information: https://docs.inventree.org