The External Machine Management section of the InvenTree API schema is documented below.
InvenTree API 435¶
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: name. |
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": "e4acd829-1ddf-48aa-9ff2-8633a56b241e",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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"
}
},
"required": [
"count",
"results"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "2d656dc9-32cb-4772-9a6b-d284996952b3",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "6b64e546-1487-442c-8306-2916700ea013",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "505d173b-4b25-42b9-8edd-387f216f6d50",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"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": "d071aac4-e34e-460c-8ab4-527a3a42c7ef",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"status_text"
],
"type": "object"
}
GET /api/machine/drivers/¶
Description
List all machine drivers.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "Machine registry status, showing all errors that were registered.",
"properties": {
"registry_errors": {
"items": {
"$ref": "#/components/schemas/MachineRegistryError"
},
"type": "array"
}
},
"required": [
"registry_errors"
],
"type": "object"
}
GET /api/machine/types/¶
Description
List of all machine types.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "867b5d4e-81e5-49f0-91d5-bd4ea5d96908",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "fa018290-52a8-4c4c-a41f-82a30dcb92fc",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"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": "2ee1f456-189b-4eef-8b65-46f3791aaa51",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"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": "afe9b811-25ec-481d-b06b-31f95f0a0cf4",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"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": "b8ccb48d-80ca-43f4-bba7-3666d18baa46",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "96506491-6408-4c7d-9b45-46d2fda5f73f",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "b24b257d-b2cc-472a-9ef0-dfdabbd2cb19",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"status_text"
],
"type": "object"
}
{
"active": true,
"driver": "string",
"initialized": true,
"is_driver_available": true,
"machine_errors": [
"string"
],
"machine_type": "string",
"name": "string",
"pk": "d0a6eacf-fbd0-4f63-ad53-f687ccff1248",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"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": "7a262575-88f2-408b-bed2-8b6cc2f279df",
"properties": [
{
"group": "string",
"key": "string",
"max_progress": 0,
"type": null,
"value": "string"
}
],
"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": "Indicator if machine is initialized.",
"readOnly": true,
"type": "boolean"
},
"is_driver_available": {
"description": "Indicator if driver for machine is available.",
"readOnly": true,
"type": "boolean"
},
"machine_errors": {
"description": "List of machine errors.",
"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"
},
"properties": {
"default": [],
"items": {
"$ref": "#/components/schemas/MachineProperty"
},
"readOnly": true,
"type": "array"
},
"restart_required": {
"description": "Indicator if machine restart is required.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Numerical machine status if available, else -1.",
"readOnly": true,
"type": "integer"
},
"status_model": {
"description": "Textual machine status name if available, else None.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status_text": {
"description": "Current status text for machine.",
"readOnly": true,
"type": "string"
}
},
"required": [
"driver",
"initialized",
"is_driver_available",
"machine_errors",
"machine_type",
"name",
"pk",
"properties",
"restart_required",
"status",
"status_text"
],
"type": "object"
}
POST /api/machine/{id}/restart/¶
Description
Restart machine by pk.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"config_type",
"description",
"key",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"units",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"config_type",
"description",
"key",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"units",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"config_type",
"description",
"key",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"config_type",
"description",
"key",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"config_type",
"description",
"key",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": [
null
],
"config_type": null,
"description": "string",
"key": "string",
"model_filters": {},
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the MachineSetting model.",
"properties": {
"api_url": {
"nullable": true,
"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_filters": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"model_name": {
"nullable": true,
"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"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"choices",
"config_type",
"description",
"key",
"model_filters",
"name",
"pk",
"required",
"typ",
"type",
"units",
"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) |
properties |
Array<MachineProperty> |
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) |
properties |
Array<MachineProperty> |
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 |
MachineProperty¶
| Name | Type |
|---|---|
group |
string |
key |
string |
max_progress |
integer| null |
type |
|
value |
string |
MachinePropertyTypeEnum¶
Type: string
MachineRegistryError¶
| Name | Type |
|---|---|
message |
string |
MachineRegistryStatus¶
| Name | Type |
|---|---|
registry_errors |
Array<MachineRegistryError> |
MachineRestart¶
| Name | Type |
|---|---|
ok |
boolean |
MachineSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
config_type |
|
description |
string |
key |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
units |
string |
value |
string| null |
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) |
properties |
Array<MachineProperty> |
restart_required |
boolean |
status |
integer |
status_model |
string| null |
status_text |
string |
PatchedMachineSetting¶
| Name | Type |
|---|---|
api_url |
string| null |
choices |
Array<> |
config_type |
|
description |
string |
key |
string |
model_filters |
|
model_name |
string| null |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
units |
string |
value |
string| null |
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 0
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.TooManyRequests¶
Too many requests.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| 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