Skip to content

The Plugin Functionality section of the InvenTree API schema is documented below.

InvenTree API 198

API for InvenTree - the intuitive open source inventory management system


License: MIT

Servers

Description URL
http://localhost:8000 http://localhost:8000

plugins


GET /api/plugins/

Description

API endpoint for list of PluginConfig objects.

  • GET: Return a list of all PluginConfig objects

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
builtin query boolean No Builtin
installed query boolean No Installed
limit query integer No Number of results to return per page.
mixin query string No Mixin
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.
sample query boolean No Sample
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "active": true,
            "is_builtin": true,
            "is_installed": true,
            "is_package": true,
            "is_sample": true,
            "key": "string",
            "meta": {},
            "mixins": {},
            "name": "string",
            "package_name": "string",
            "pk": 0
        }
    ]
}
⚠️ 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/PluginConfig"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/plugins/install/

Description

Endpoint for installing a new plugin.

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

{
    "confirm": true,
    "packagename": "string",
    "url": "string",
    "version": "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 installing a new plugin.",
    "properties": {
        "confirm": {
            "description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
            "title": "Confirm plugin installation",
            "type": "boolean"
        },
        "packagename": {
            "description": "Name for the Plugin Package - can also contain a version indicator",
            "title": "Package Name",
            "type": "string"
        },
        "url": {
            "description": "Source for the package - this can be a custom registry or a VCS path",
            "title": "Source URL",
            "type": "string"
        },
        "version": {
            "description": "Version specifier for the plugin. Leave blank for latest version.",
            "type": "string"
        }
    },
    "required": [
        "confirm"
    ],
    "type": "object"
}

{
    "confirm": true,
    "packagename": "string",
    "url": "string",
    "version": "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 installing a new plugin.",
    "properties": {
        "confirm": {
            "description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
            "title": "Confirm plugin installation",
            "type": "boolean"
        },
        "packagename": {
            "description": "Name for the Plugin Package - can also contain a version indicator",
            "title": "Package Name",
            "type": "string"
        },
        "url": {
            "description": "Source for the package - this can be a custom registry or a VCS path",
            "title": "Source URL",
            "type": "string"
        },
        "version": {
            "description": "Version specifier for the plugin. Leave blank for latest version.",
            "type": "string"
        }
    },
    "required": [
        "confirm"
    ],
    "type": "object"
}

{
    "confirm": true,
    "packagename": "string",
    "url": "string",
    "version": "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 installing a new plugin.",
    "properties": {
        "confirm": {
            "description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
            "title": "Confirm plugin installation",
            "type": "boolean"
        },
        "packagename": {
            "description": "Name for the Plugin Package - can also contain a version indicator",
            "title": "Package Name",
            "type": "string"
        },
        "url": {
            "description": "Source for the package - this can be a custom registry or a VCS path",
            "title": "Source URL",
            "type": "string"
        },
        "version": {
            "description": "Version specifier for the plugin. Leave blank for latest version.",
            "type": "string"
        }
    },
    "required": [
        "confirm"
    ],
    "type": "object"
}

Response 201 Created

{
    "confirm": true,
    "packagename": "string",
    "url": "string",
    "version": "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 installing a new plugin.",
    "properties": {
        "confirm": {
            "description": "This will install this plugin now into the current instance. The instance will go into maintenance.",
            "title": "Confirm plugin installation",
            "type": "boolean"
        },
        "packagename": {
            "description": "Name for the Plugin Package - can also contain a version indicator",
            "title": "Package Name",
            "type": "string"
        },
        "url": {
            "description": "Source for the package - this can be a custom registry or a VCS path",
            "title": "Source URL",
            "type": "string"
        },
        "version": {
            "description": "Version specifier for the plugin. Leave blank for latest version.",
            "type": "string"
        }
    },
    "required": [
        "confirm"
    ],
    "type": "object"
}

POST /api/plugins/reload/

Description

Endpoint for reloading all plugins.

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

{
    "collect_plugins": true,
    "force_reload": true,
    "full_reload": 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 request body
{
    "description": "Serializer for remotely forcing plugin registry reload.",
    "properties": {
        "collect_plugins": {
            "default": false,
            "description": "Collect plugins and add them to the registry",
            "type": "boolean"
        },
        "force_reload": {
            "default": false,
            "description": "Force a reload of the plugin registry, even if it is already loaded",
            "type": "boolean"
        },
        "full_reload": {
            "default": false,
            "description": "Perform a full reload of the plugin registry",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "collect_plugins": true,
    "force_reload": true,
    "full_reload": 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 request body
{
    "description": "Serializer for remotely forcing plugin registry reload.",
    "properties": {
        "collect_plugins": {
            "default": false,
            "description": "Collect plugins and add them to the registry",
            "type": "boolean"
        },
        "force_reload": {
            "default": false,
            "description": "Force a reload of the plugin registry, even if it is already loaded",
            "type": "boolean"
        },
        "full_reload": {
            "default": false,
            "description": "Perform a full reload of the plugin registry",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "collect_plugins": true,
    "force_reload": true,
    "full_reload": 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 request body
{
    "description": "Serializer for remotely forcing plugin registry reload.",
    "properties": {
        "collect_plugins": {
            "default": false,
            "description": "Collect plugins and add them to the registry",
            "type": "boolean"
        },
        "force_reload": {
            "default": false,
            "description": "Force a reload of the plugin registry, even if it is already loaded",
            "type": "boolean"
        },
        "full_reload": {
            "default": false,
            "description": "Perform a full reload of the plugin registry",
            "type": "boolean"
        }
    },
    "type": "object"
}

Response 201 Created

{
    "collect_plugins": true,
    "force_reload": true,
    "full_reload": 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 remotely forcing plugin registry reload.",
    "properties": {
        "collect_plugins": {
            "default": false,
            "description": "Collect plugins and add them to the registry",
            "type": "boolean"
        },
        "force_reload": {
            "default": false,
            "description": "Force a reload of the plugin registry, even if it is already loaded",
            "type": "boolean"
        },
        "full_reload": {
            "default": false,
            "description": "Perform a full reload of the plugin registry",
            "type": "boolean"
        }
    },
    "type": "object"
}

GET /api/plugins/settings/

Description

List endpoint for all plugin related settings.

  • read only
  • only accessible by staff users

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"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
plugin__active query boolean No
plugin__key query string No

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": [
        {
            "api_url": "string",
            "choices": [
                null
            ],
            "description": "string",
            "key": "string",
            "model_name": "string",
            "name": "string",
            "pk": 0,
            "plugin": "string",
            "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
{
    "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/PluginSetting"
            },
            "type": "array"
        }
    },
    "type": "object"
}

GET /api/plugins/status/

Description

Show plugin registry status information.

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

{
    "active_plugins": 0,
    "registry_errors": [
        {
            "message": "string",
            "name": "string",
            "stage": "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 plugin registry status.",
    "properties": {
        "active_plugins": {
            "readOnly": true,
            "type": "integer"
        },
        "registry_errors": {
            "items": {
                "$ref": "#/components/schemas/PluginRegistryError"
            },
            "type": "array"
        }
    },
    "required": [
        "active_plugins",
        "registry_errors"
    ],
    "type": "object"
}

DELETE /api/plugins/{plugin}/

Description

Handle DELETE request for a PluginConfig instance.

We only allow plugin deletion if the plugin is not active.

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"
plugin path string No

Response 204 No Content


GET /api/plugins/{plugin}/

Description

API detail endpoint for PluginConfig object.

get: Return a single PluginConfig object

post: Update a PluginConfig

delete: Remove a PluginConfig

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"
plugin path string No

Response 200 OK

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "is_builtin",
        "is_installed",
        "is_package",
        "is_sample",
        "key",
        "meta",
        "mixins",
        "pk"
    ],
    "type": "object"
}

PATCH /api/plugins/{plugin}/

Description

API detail endpoint for PluginConfig object.

get: Return a single PluginConfig object

post: Update a PluginConfig

delete: Remove a PluginConfig

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"
plugin path string No

Request body

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "is_builtin",
        "is_installed",
        "is_package",
        "is_sample",
        "key",
        "meta",
        "mixins",
        "pk"
    ],
    "type": "object"
}

PUT /api/plugins/{plugin}/

Description

API detail endpoint for PluginConfig object.

get: Return a single PluginConfig object

post: Update a PluginConfig

delete: Remove a PluginConfig

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"
plugin path string No

Request body

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "is_builtin",
        "is_installed",
        "is_package",
        "is_sample",
        "key",
        "meta",
        "mixins",
        "pk"
    ],
    "type": "object"
}

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "is_builtin",
        "is_installed",
        "is_package",
        "is_sample",
        "key",
        "meta",
        "mixins",
        "pk"
    ],
    "type": "object"
}

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "is_builtin",
        "is_installed",
        "is_package",
        "is_sample",
        "key",
        "meta",
        "mixins",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

{
    "active": true,
    "is_builtin": true,
    "is_installed": true,
    "is_package": true,
    "is_sample": true,
    "key": "string",
    "meta": {},
    "mixins": {},
    "name": "string",
    "package_name": "string",
    "pk": 0
}
⚠️ 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 PluginConfig.",
    "properties": {
        "active": {
            "description": "Is the plugin active",
            "type": "boolean"
        },
        "is_builtin": {
            "description": "Return True if this is a 'builtin' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_installed": {
            "description": "Simple check to determine if this plugin is installed.\n\nA plugin might not be installed if it has been removed from the system,\nbut the PluginConfig associated with it still exists.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_package": {
            "description": "Return True if this is a 'package' plugin.",
            "readOnly": true,
            "type": "boolean"
        },
        "is_sample": {
            "description": "Is this plugin a sample app?",
            "readOnly": true,
            "type": "boolean"
        },
        "key": {
            "description": "Key of plugin",
            "readOnly": true,
            "type": "string"
        },
        "meta": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "mixins": {
            "additionalProperties": {},
            "readOnly": true,
            "type": "object"
        },
        "name": {
            "description": "PluginName of the plugin",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "package_name": {
            "description": "Name of the installed package, if the plugin was installed via PIP",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "is_builtin",
        "is_installed",
        "is_package",
        "is_sample",
        "key",
        "meta",
        "mixins",
        "pk"
    ],
    "type": "object"
}

PATCH /api/plugins/{plugin}/activate/

Description

Endpoint for activating a plugin.

  • PATCH: Activate a plugin

Pass a boolean value for the 'active' field. If not provided, it is assumed to be True, and the plugin will be activated.

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"
plugin path string No

Request body

{
    "active": 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 request body
{
    "description": "Serializer for activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "active": 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 request body
{
    "description": "Serializer for activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "active": 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 request body
{
    "description": "Serializer for activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "active": 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 activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

PUT /api/plugins/{plugin}/activate/

Description

Endpoint for activating a plugin.

  • PATCH: Activate a plugin

Pass a boolean value for the 'active' field. If not provided, it is assumed to be True, and the plugin will be activated.

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"
plugin path string No

Request body

{
    "active": 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 request body
{
    "description": "Serializer for activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "active": 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 request body
{
    "description": "Serializer for activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "active": 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 request body
{
    "description": "Serializer for activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "active": 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 activating or deactivating a plugin.",
    "properties": {
        "active": {
            "default": true,
            "description": "Activate this plugin",
            "title": "Activate Plugin",
            "type": "boolean"
        }
    },
    "type": "object"
}

GET /api/plugins/{plugin}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

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"
plugin path string No

Response 200 OK

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

PATCH /api/plugins/{plugin}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

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"
plugin path string No

Request body

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

PUT /api/plugins/{plugin}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

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"
plugin path string No

Request body

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

{
    "metadata": null
}
⚠️ 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

GET /api/plugins/{plugin}/settings/

Description

Get all settings for a plugin 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"
plugin path string No

Response 200 OK

[
    {
        "api_url": "string",
        "choices": [
            null
        ],
        "description": "string",
        "key": "string",
        "model_name": "string",
        "name": "string",
        "pk": 0,
        "plugin": "string",
        "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/PluginSetting"
    },
    "type": "array"
}

GET /api/plugins/{plugin}/settings/{key}/

Description

Detail endpoint for a plugin-specific setting.

Note that these cannot be created or deleted via the 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"
key path string No
plugin path string No

Response 200 OK

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "required": [
        "api_url",
        "choices",
        "description",
        "key",
        "model_name",
        "name",
        "pk",
        "plugin",
        "required",
        "typ",
        "type",
        "value"
    ],
    "type": "object"
}

PATCH /api/plugins/{plugin}/settings/{key}/

Description

Detail endpoint for a plugin-specific setting.

Note that these cannot be created or deleted via the 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"
key path string No
plugin path string No

Request body

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "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
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "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
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "required": [
        "api_url",
        "choices",
        "description",
        "key",
        "model_name",
        "name",
        "pk",
        "plugin",
        "required",
        "typ",
        "type",
        "value"
    ],
    "type": "object"
}

PUT /api/plugins/{plugin}/settings/{key}/

Description

Detail endpoint for a plugin-specific setting.

Note that these cannot be created or deleted via the 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"
key path string No
plugin path string No

Request body

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "required": [
        "api_url",
        "choices",
        "description",
        "key",
        "model_name",
        "name",
        "pk",
        "plugin",
        "required",
        "typ",
        "type",
        "value"
    ],
    "type": "object"
}

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "required": [
        "api_url",
        "choices",
        "description",
        "key",
        "model_name",
        "name",
        "pk",
        "plugin",
        "required",
        "typ",
        "type",
        "value"
    ],
    "type": "object"
}

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "required": [
        "api_url",
        "choices",
        "description",
        "key",
        "model_name",
        "name",
        "pk",
        "plugin",
        "required",
        "typ",
        "type",
        "value"
    ],
    "type": "object"
}

Response 200 OK

{
    "api_url": "string",
    "choices": [
        null
    ],
    "description": "string",
    "key": "string",
    "model_name": "string",
    "name": "string",
    "pk": 0,
    "plugin": "string",
    "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 PluginSetting model.",
    "properties": {
        "api_url": {
            "readOnly": true,
            "type": "string"
        },
        "choices": {
            "description": "Returns the choices available for a given item.",
            "items": {},
            "readOnly": true,
            "type": "array"
        },
        "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"
        },
        "plugin": {
            "readOnly": true,
            "type": "string"
        },
        "required": {
            "readOnly": true,
            "type": "boolean"
        },
        "typ": {
            "readOnly": true,
            "type": "string"
        },
        "type": {
            "readOnly": true,
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    },
    "required": [
        "api_url",
        "choices",
        "description",
        "key",
        "model_name",
        "name",
        "pk",
        "plugin",
        "required",
        "typ",
        "type",
        "value"
    ],
    "type": "object"
}

PATCH /api/plugins/{plugin}/uninstall/

Description

Endpoint for uninstalling a single plugin.

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"
plugin path string No

Request body

{
    "delete_config": 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 request body
{
    "description": "Serializer for uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "delete_config": 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 request body
{
    "description": "Serializer for uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "delete_config": 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 request body
{
    "description": "Serializer for uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "delete_config": 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 uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

PUT /api/plugins/{plugin}/uninstall/

Description

Endpoint for uninstalling a single plugin.

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"
plugin path string No

Request body

{
    "delete_config": 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 request body
{
    "description": "Serializer for uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "delete_config": 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 request body
{
    "description": "Serializer for uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "delete_config": 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 request body
{
    "description": "Serializer for uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "delete_config": 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 uninstalling a plugin.",
    "properties": {
        "delete_config": {
            "default": true,
            "description": "Delete the plugin configuration from the database",
            "title": "Delete configuration",
            "type": "boolean"
        }
    },
    "type": "object"
}

Schemas

Metadata

Name Type
metadata

PaginatedPluginConfigList

Name Type
count integer
next string(uri)| null
previous string(uri)| null
results Array<PluginConfig>

PaginatedPluginSettingList

Name Type
count integer
next string(uri)| null
previous string(uri)| null
results Array<PluginSetting>

PatchedMetadata

Name Type
metadata

PatchedPluginActivate

Name Type
active boolean

PatchedPluginConfig

Name Type
active boolean
is_builtin boolean
is_installed boolean
is_package boolean
is_sample boolean
key string
meta
mixins
name string| null
package_name string| null
pk integer

PatchedPluginSetting

Name Type
api_url string
choices Array<>
description string
key string
model_name string
name string
pk integer
plugin string
required boolean
typ string
type string
value string

PatchedPluginUninstall

Name Type
delete_config boolean

PluginActivate

Name Type
active boolean

PluginConfig

Name Type
active boolean
is_builtin boolean
is_installed boolean
is_package boolean
is_sample boolean
key string
meta
mixins
name string| null
package_name string| null
pk integer

PluginConfigInstall

Name Type
confirm boolean
packagename string
url string
version string

PluginRegistryError

Name Type
message string
name string
stage string

PluginRegistryStatus

Name Type
active_plugins integer
registry_errors Array<PluginRegistryError>

PluginReload

Name Type
collect_plugins boolean
force_reload boolean
full_reload boolean

PluginSetting

Name Type
api_url string
choices Array<>
description string
key string
model_name string
name string
pk integer
plugin string
required boolean
typ string
type string
value string

PluginUninstall

Name Type
delete_config boolean

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