### GET /dongle/devices/devices_lean/ Source: https://api.autopi.io/index_format=openapi Retrieves a concise list of all dongle devices. ```APIDOC ## GET /dongle/devices/devices_lean/ ### Description Retrieves a concise list of all dongle devices. ### Method GET ### Endpoint /dongle/devices/devices_lean/ ### Parameters #### Query Parameters None ### Response #### Success Response (200) - **[]** (array) - A list of Device objects with lean information. #### Response Example { "example": "[ { "device_id": "some-device-id", "unit_id": "some-unit-id", "name": "Device Name" } ]" } ``` -------------------------------- ### GET /dongle/engines/by_name/{name}/ Source: https://api.autopi.io/index_format=openapi Retrieves engines by their name, with optional filtering and searching. ```APIDOC ## GET /dongle/engines/by_name/{name}/ ### Description Retrieves engines that match the specified name. Supports filtering by device and searching. ### Method GET ### Endpoint /dongle/engines/by_name/{name}/ ### Parameters #### Path Parameters - **name** (string) - Required - The name of the engine to retrieve. #### Query Parameters - **device** (string) - Optional - Filter engines belonging to a specific device. - **ordering** (string) - Optional - Field to use for ordering the results. - **search** (string) - Optional - A search term. ### Response #### Success Response (200) - **engines** (array) - A list of engine objects matching the name. #### Response Example ```json [ { "id": "engine-uuid-1", "name": "Engine A", "device_id": "device-uuid-1" } ] ``` ``` -------------------------------- ### GET /fleet/vehicles/states/ Source: https://api.autopi.io/index_format=openapi A custom view to get all states. ```APIDOC ## GET /fleet/vehicles/states/ ### Description A custom view to get all states. ### Method GET ### Endpoint /fleet/vehicles/states/ ### Parameters #### Query Parameters - **parent** (integer) - Query - Parent ID ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **example** (array) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /dongle/engines/ Source: https://api.autopi.io/index_format=openapi Creates a new engine. ```APIDOC ## POST /dongle/engines/ ### Description Creates a new engine. ### Method POST ### Endpoint /dongle/engines/ ### Parameters #### Request Body - **name** (string) - Required - The name of the engine. - **device_id** (string) - Required - The ID of the device this engine belongs to. ### Request Example ```json { "name": "New Engine", "device_id": "device-uuid-1" } ``` ### Response #### Success Response (201) - **engine** (object) - The newly created engine object. #### Response Example ```json { "id": "engine-uuid-3", "name": "New Engine", "device_id": "device-uuid-1" } ``` ``` -------------------------------- ### List and Create Dongle Engines Source: https://api.autopi.io/index_format=openapi Retrieve a list of dongle engines or create a new one. ```APIDOC ## GET /dongle/engines/ ### Description Retrieves a list of dongle engines. ### Method GET ### Endpoint /dongle/engines/ ### Query Parameters - **device** (string) - Optional - Description not provided - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. ### Response #### Success Response (200) - **items** (array) - A list of Engine objects. #### Response Example ```json [ { "id": 1, "name": "Example Engine" } ] ``` ## POST /dongle/engines/ ### Description Creates a new dongle engine. ### Method POST ### Endpoint /dongle/engines/ ### Request Body - **data** (object) - Required - Engine object to create. ### Request Example ```json { "name": "New Engine" } ``` ### Response #### Success Response (201) - **Engine** (object) - The created Engine object. #### Response Example ```json { "id": 2, "name": "New Engine" } ``` ``` -------------------------------- ### GET /fleet/vehicles/fleet_states/ Source: https://api.autopi.io/index_format=openapi A custom view to get all fleet states. ```APIDOC ## GET /fleet/vehicles/fleet_states/ ### Description A custom view to get all states. ### Method GET ### Endpoint /fleet/vehicles/fleet_states/ ### Parameters #### Query Parameters - **parent** (integer) - Query - Parent ID ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **example** (array) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Dongle Engine Render Settings Preview Source: https://api.autopi.io/index_format=openapi Get a preview of render settings for a specific dongle engine. ```APIDOC ## GET /dongle/engines/{id}/render_settings_preview/ ### Description Retrieves a preview of render settings for a specific dongle engine. ### Method GET ### Endpoint /dongle/engines/{id}/render_settings_preview/ ### Path Parameters - **id** (integer) - Required - A unique integer value identifying this engine. ### Response #### Success Response (200) - **Engine** (object) - The Engine object with render settings preview. #### Response Example ```json { "id": 1, "name": "Example Engine", "render_settings": { "resolution": "1080p" } } ``` ``` -------------------------------- ### GET /fleet/vehicles/{id}/rewards/ Source: https://api.autopi.io/index_format=openapi Get vehicle earnings by its ID. ```APIDOC ## GET /fleet/vehicles/{id}/rewards/ ### Description Get vehicle earnings by its ID. ### Method GET ### Endpoint /fleet/vehicles/{id}/rewards/ ### Parameters #### Path Parameters - **id** (integer) - Required - A unique integer value identifying this Vehicle. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **example** (FleetVehicleEarnings) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /docker/projects/ Source: https://api.autopi.io/index_format=openapi Create a new Docker project. Projects are used to group releases together. ```APIDOC ## POST /docker/projects/ ### Description Create a new Docker project. Projects are used to group releases together and are required to create releases. ### Method POST ### Endpoint /docker/projects/ ### Parameters #### Request Body - **data** (object) - Required - The project data. - **name** (string) - Required - The name of the project. - **description** (string) - Optional - A description for the project. ### Request Example ```json { "name": "New Project", "description": "Project for new features" } ``` ### Response #### Success Response (201) - **id** (integer) - The unique identifier for the newly created project. - **name** (string) - The name of the project. - **description** (string) - The description of the project. #### Response Example ```json { "id": 5, "name": "New Project", "description": "Project for new features" } ``` ``` -------------------------------- ### GET /fleet/vehicles/{id}/states/ Source: https://api.autopi.io/index_format=openapi A custom view to get all states for a specific vehicle. ```APIDOC ## GET /fleet/vehicles/{id}/states/ ### Description A custom view to get all states for a specific vehicle. ### Method GET ### Endpoint /fleet/vehicles/{id}/states/ ### Parameters #### Path Parameters - **id** (integer) - Required - A unique integer value identifying this Vehicle. #### Query Parameters - **parent** (integer) - Query - Parent ID ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **example** (array) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /dongle/devices/batch_schedule_update/ Source: https://api.autopi.io/index_format=openapi Schedules a batch update on multiple devices. ```APIDOC ## POST /dongle/devices/batch_schedule_update/ ### Description Schedule a batch update on devices. ### Method POST ### Endpoint `/dongle/devices/batch_schedule_update/` ### Parameters #### Request Body - **data** (BatchScheduleUpdate) - Required - The batch schedule update object. ``` -------------------------------- ### GET /fleet/vehicles/{id}/fleet_states/ Source: https://api.autopi.io/index_format=openapi A custom view to get all fleet states for a specific vehicle. ```APIDOC ## GET /fleet/vehicles/{id}/fleet_states/ ### Description A custom view to get all states for a specific vehicle. ### Method GET ### Endpoint /fleet/vehicles/{id}/fleet_states/ ### Parameters #### Path Parameters - **id** (integer) - Required - A unique integer value identifying this Vehicle. #### Query Parameters - **parent** (integer) - Query - Parent ID ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **example** (array) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /auth/user/ Source: https://api.autopi.io/index_format=openapi Retrieves the current user's profile information. Supports GET, PUT, and PATCH methods. ```APIDOC ## GET /auth/user/ ### Description Retrieves the current user's profile information. Supports GET, PUT, and PATCH methods. ### Method GET ### Endpoint /auth/user/ ### Parameters ### Request Example ### Response #### Success Response (200) - **pk** (integer) - The user's primary key. - **username** (string) - The user's username. - **email** (string) - The user's email address. - **first_name** (string) - The user's first name. - **last_name** (string) - The user's last name. #### Response Example ```json { "pk": 1, "username": "testuser", "email": "test@example.com", "first_name": "Test", "last_name": "User" } ``` ``` -------------------------------- ### List and Create Environment Variables Source: https://api.autopi.io/index_format=openapi Retrieve a list of global environment variables or create a new one. ```APIDOC ## GET /dongle/environment_variables/ ### Description This endpoint returns all global environment variables, and each variable includes information about all the device overrides. ### Method GET ### Endpoint /dongle/environment_variables/ ### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. - **page** (integer) - Optional - Page number. - **page_size** (integer) - Optional - Number of items per page. ### Response #### Success Response (200) - **count** (integer) - Total number of environment variables. - **results** (array) - A list of GlobalEnvironmentVariable objects. - **page_size** (integer) - Number of items per page. #### Response Example ```json { "count": 10, "results": [ { "id": 1, "name": "API_KEY", "value": "abcdef12345" } ], "page_size": 5 } ``` ## POST /dongle/environment_variables/ ### Description This endpoint returns all global environment variables, and each variable includes information about all the device overrides. ### Method POST ### Endpoint /dongle/environment_variables/ ### Request Body - **data** (object) - Required - GlobalEnvironmentVariable object to create. ### Request Example ```json { "name": "NEW_VAR", "value": "new_value" } ``` ### Response #### Success Response (201) - **GlobalEnvironmentVariable** (object) - The created GlobalEnvironmentVariable object. #### Response Example ```json { "id": 2, "name": "NEW_VAR", "value": "new_value" } ``` ``` -------------------------------- ### GET /auth/featureflags/ Source: https://api.autopi.io/index_format=openapi Retrieves feature flags. ```APIDOC ## GET /auth/featureflags/ ### Description Retrieves feature flags. ### Method GET ### Endpoint /auth/featureflags/ ### Parameters ### Request Example ### Response #### Success Response (200) #### Response Example ``` -------------------------------- ### POST /dongle/reactors/ Source: https://api.autopi.io/index_format=openapi Creates a new event reactor for a dongle. Requires device and engine identifiers, with an optional template. ```APIDOC ## POST /dongle/reactors/ ### Description Creates a new event reactor. Requires device and engine identifiers, with an optional template. ### Method POST ### Endpoint /dongle/reactors/ ### Parameters #### Query Parameters - **device** (string) - Required - Identifier for the device. - **engine** (string) - Required - Identifier for the engine. - **template** (string) - Optional - Identifier for the template. #### Request Body - **data** (WriteableEventReactor) - Required - The event reactor configuration. ### Request Example ```json { "example": "WriteableEventReactor object" } ``` ### Response #### Success Response (201) - **WriteableEventReactor** (object) - The created event reactor object. #### Response Example ```json { "example": "WriteableEventReactor object" } ``` ``` -------------------------------- ### GET /vehicle/models/ Source: https://api.autopi.io/index_format=openapi Lists all available vehicle models. ```APIDOC ## GET /vehicle/models/ ### Description Lists all available vehicle models. ### Method GET ### Endpoint /vehicle/models/ ### Response #### Success Response (200) - **Model** (array) - A list of vehicle models. ``` -------------------------------- ### POST /dongle/settings/ Source: https://api.autopi.io/index_format=openapi Sets or updates settings for a device. Requires the device ID and the settings data. Refer to the /dongle/settings/schema/ endpoint for available settings. ```APIDOC ## POST /dongle/settings/ ### Description Sets or updates settings for a device. Requires the device ID and the settings data. Refer to the /dongle/settings/schema/ endpoint for available settings. ### Method POST ### Endpoint /dongle/settings/ ### Parameters #### Query Parameters - **device_id** (string) - Optional - The ID of the device to set settings for. #### Request Body - **data** (Settings) - Required - The settings object to be applied. ### Response #### Success Response (200) - **Settings** (object) - An object confirming the updated device settings. #### Response Example ```json { "example": "Settings object" } ``` ``` -------------------------------- ### GET /vehicle/makes/ Source: https://api.autopi.io/index_format=openapi Lists all available vehicle makes. ```APIDOC ## GET /vehicle/makes/ ### Description Lists all available vehicle makes. ### Method GET ### Endpoint /vehicle/makes/ ### Response #### Success Response (200) - **Make** (array) - A list of vehicle makes. ``` -------------------------------- ### GET /dashboard/layout/ Source: https://api.autopi.io/index_format=openapi Retrieves a list of dashboard layouts. ```APIDOC ## GET /dashboard/layout/ ### Description Retrieves a list of dashboard layouts. ### Method GET ### Endpoint /dashboard/layout/ ### Parameters #### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **schema** (array of Dashboard) - A list of Dashboard objects. #### Response Example { "example": "[ { \"id\": 1, \"title\": \"Dashboard 1\", \"layout\": { ... } }, { \"id\": 2, \"title\": \"Dashboard 2\", \"layout\": { ... } } ]" } ``` -------------------------------- ### POST /dongle/devices/{id}/execute/ Source: https://api.autopi.io/index_format=openapi Executes a command on a dongle device. ```APIDOC ## POST /dongle/devices/{id}/execute/ ### Description Executes a command on a dongle device. ### Method POST ### Endpoint /dongle/devices/{id}/execute/ ### Parameters #### Path Parameters - **id** (string format: uuid) - Required - A UUID string identifying this device. #### Request Body - **data** (object) - Required - Schema defining the command to execute. ### Response #### Success Response (200) - **ExecuteCommandResponse** (object) - Schema for the successful command execution response. #### Error Response (400) - **ExecuteCommandStatusResponse** (object) - Schema for the command execution status response in case of an error. #### Response Example ```json { "example": "command execution response" } ``` ``` -------------------------------- ### POST /dongle/devices/{id}/factory_reset/ Source: https://api.autopi.io/index_format=openapi Initiates a factory reset for a specific device. ```APIDOC ## POST /dongle/devices/{id}/factory_reset/ ### Description Initiates a factory reset procedure for the specified device. ### Method POST ### Endpoint /dongle/devices/{id}/factory_reset/ ### Parameters #### Path Parameters - **id** (string) - Required - A UUID string identifying this device. #### Request Body - **confirmation** (boolean) - Required - Must be true to confirm the factory reset. ### Request Example ```json { "confirmation": true } ``` ### Response #### Success Response (201) - **status** (string) - Indicates the factory reset has been initiated. #### Response Example ```json { "status": "Factory reset initiated" } ``` ``` -------------------------------- ### GET /billing/subscriptions/active_summary/ Source: https://api.autopi.io/index_format=openapi Lists active subscriptions with their summaries. ```APIDOC ## GET /billing/subscriptions/active_summary/ ### Description Lists active subscriptions with their summaries. ### Method GET ### Endpoint /billing/subscriptions/active_summary/ ### Parameters #### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **page** (integer) - Optional - Page number. - **page_size** (integer) - Optional - Number of items per page. ### Response #### Success Response (200) - **results** (array) - A list of subscription summaries. - *See SubscriptionSummary schema for details* - **count** (integer) - The total number of items available. - **page_size** (integer) - The number of items per page. ``` -------------------------------- ### POST /auth/register/ Source: https://api.autopi.io/index_format=openapi Registers a new user. ```APIDOC ## POST /auth/register/ ### Description Registers a new user. ### Method POST ### Endpoint /auth/register/ ### Parameters #### Request Body - **data** (object) - Required - User registration details. ### Request Example ```json { "username": "string", "email": "string", "password": "string" } ``` ### Response #### Success Response (201) - **user_data** (object) - Details of the newly registered user. #### Response Example ```json { "username": "newuser", "email": "newuser@example.com" } ``` ``` -------------------------------- ### GET /billing/settlements/ Source: https://api.autopi.io/index_format=openapi Lists invoices for billing settlements. ```APIDOC ## GET /billing/settlements/ ### Description Lists invoices for billing settlements. ### Method GET ### Endpoint /billing/settlements/ ### Parameters #### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **page** (integer) - Optional - Page number. - **page_size** (integer) - Optional - Number of items per page. ### Response #### Success Response (200) - **(object)** - A paginated list of settlement invoices. - *See PagedSettlement schema for details* ``` -------------------------------- ### GET /automation/triggers/ Source: https://api.autopi.io/index_format=openapi Retrieves a list of automation triggers. ```APIDOC ## GET /automation/triggers/ ### Description Retrieves a list of automation triggers. ### Method GET ### Endpoint /automation/triggers/ ### Parameters #### Query Parameters - **device** (string) - Optional - Filters triggers by device. - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. ### Response #### Success Response (200) - **results** (array) - A list of triggers. - **count** (integer) - The total number of items available. - **page_size** (integer) - The number of items per page. ``` -------------------------------- ### POST /dongle/devices/{id}/execute_raw/ Source: https://api.autopi.io/index_format=openapi Executes a raw command on a dongle device. ```APIDOC ## POST /dongle/devices/{id}/execute_raw/ ### Description Executes a raw command on a dongle device. ### Method POST ### Endpoint /dongle/devices/{id}/execute_raw/ ### Parameters #### Path Parameters - **id** (string format: uuid) - Required - A UUID string identifying this device. #### Request Body - **data** (object) - Required - Schema defining the raw command to execute. ### Response #### Success Response (200) - **description** (string) - Returns the result of the raw command execution. #### Response Example ```json { "example": "raw command execution result" } ``` ``` -------------------------------- ### GET /automation/tags Source: https://api.autopi.io/index_format=openapi Retrieves a list of automation tags. ```APIDOC ## GET /automation/tags ### Description Retrieves a list of automation tags. ### Method GET ### Endpoint /automation/tags ### Parameters #### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. ### Response #### Success Response (200) - **results** (array) - A list of automation tags. - **count** (integer) - The total number of items available. - **page_size** (integer) - The number of items per page. ``` -------------------------------- ### GET /docker/projects/ Source: https://api.autopi.io/index_format=openapi Retrieve a list of all Docker projects. Supports filtering, searching, and pagination. ```APIDOC ## GET /docker/projects/ ### Description Retrieve a list of all Docker projects. Supports filtering, searching, and pagination. A project is used to group releases together and is required to create releases. ### Method GET ### Endpoint /docker/projects/ ### Parameters #### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. - **page** (integer) - Optional - Page number - **page_size** (integer) - Optional - Number of items per page ### Response #### Success Response (200) - **count** (integer) - The total number of projects available. - **results** (array) - A list of Project objects. - **page_size** (integer) - The number of items per page. #### Response Example ```json { "count": 10, "results": [ { "id": 1, "name": "Example Project", "description": "This is an example project." } ], "page_size": 10 } ``` ``` -------------------------------- ### GET /logbook/events_histogram/ Source: https://api.autopi.io/index_format=openapi Returns a histogram of events logged by a device. ```APIDOC ## GET /logbook/events_histogram/ ### Description Returns events histogram from your device. ### Method GET ### Endpoint /logbook/events_histogram/ ### Parameters #### Query Parameters - **device_id** (string) - Optional - ID of the device you want to load diagnostics for (NOT Unit ID). - **search** (string) - Optional - A search term. ### Request Example ```json { "example": "GET request for event histogram" } ``` ### Response #### Success Response (200) - **Response** (object) - Contains the event histogram data. #### Response Example ```json { "example": "Response body with event histogram" } ``` ``` -------------------------------- ### Apply Template Source: https://api.autopi.io/index_format=openapi Endpoints for applying template configurations to devices. ```APIDOC ## POST /dongle/templates/{id}/apply/ ### Description Applies template configuration to devices. ### Method POST ### Endpoint /dongle/templates/{id}/apply/ ### Path Parameters - **id** (integer) - Required - A unique integer value identifying this template. ### Response #### Success Response (200) - Description: Applied template to all associated devices. #### Error Response (400) - Description: No devices associated to the template. ## POST /dongle/templates/{id}/apply_async/ ### Description Applies template configuration to all devices asynchronously. ### Method POST ### Endpoint /dongle/templates/{id}/apply_async/ ### Path Parameters - **id** (integer) - Required - A unique integer value identifying this template. ### Request Body - **data** (object) - Required - The request body for applying the template asynchronously. - **devices** (array) - Optional - A list of device IDs to apply the template to. ### Request Example ```json { "devices": [1, 2, 3] } ``` ### Response #### Success Response (200) - (object) - Task object representing the asynchronous operation. #### Error Response (400) - Description: No devices associated to the template. ## POST /dongle/templates/{id}/apply_explicit/ ### Description Applies template configuration to specific devices. ### Method POST ### Endpoint /dongle/templates/{id}/apply_explicit/ ### Path Parameters - **id** (integer) - Required - A unique integer value identifying this template. ### Request Body - **data** (object) - Required - The request body for explicitly applying the template. - **devices** (array) - Required - A list of device IDs to apply the template to. ### Request Example ```json { "devices": [1, 2, 3] } ``` ### Response #### Success Response (200) - Description: Applied template to all associated devices. #### Error Response (400) - Description: No devices associated to the template. ## POST /dongle/templates/{id}/apply_explicit_async/ ### Description Applies template configuration to specific devices asynchronously. ### Method POST ### Endpoint /dongle/templates/{id}/apply_explicit_async/ ### Path Parameters - **id** (integer) - Required - A unique integer value identifying this template. ### Request Body - **data** (object) - Required - The request body for explicitly applying the template asynchronously. - **devices** (array) - Required - A list of device IDs to apply the template to. ### Request Example ```json { "devices": [1, 2, 3] } ``` ### Response #### Success Response (200) - (object) - Task object representing the asynchronous operation. #### Error Response (400) - Description: No devices associated to the template. ``` -------------------------------- ### Create User Source: https://api.autopi.io/index_format=openapi Creates a new user account. ```APIDOC ## POST /auth/account/v3/users/ ### Description Creates a new user account. ### Method POST ### Endpoint /auth/account/v3/users/ ### Parameters #### Request Body - **data** (object) - Required - The Account_User_V3 object to create. - **username** (string) - Required - The username for the new user. - **email** (string) - Required - The email address for the new user. - **password** (string) - Required - The password for the new user. - Other fields as defined by Account_User_V3 schema. ### Request Example ```json { "username": "newuser", "email": "newuser@example.com", "password": "securepassword123" } ``` ### Response #### Success Response (201) - **Account_User_V3** (object) - The created Account_User_V3 object. #### Response Example ```json { "id": 2, "username": "newuser", "email": "newuser@example.com" } ``` ``` -------------------------------- ### GET /fleet/vehicles/{id}/ Source: https://api.autopi.io/index_format=openapi Retrieves a specific vehicle by its ID. ```APIDOC ## GET /fleet/vehicles/{id}/ ### Description Retrieves a specific vehicle by its ID. ### Method GET ### Endpoint /fleet/vehicles/{id}/ ### Parameters #### Path Parameters - **id** (integer) - Required - A unique integer value identifying this Vehicle. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **example** (FleetVehicle) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /fleet/alerts/choices/ Source: https://api.autopi.io/index_format=openapi Returns available alert types for filtering. ```APIDOC ## GET /fleet/alerts/choices/ ### Description Returns available alert types for filtering. ### Method GET ### Endpoint /fleet/alerts/choices/ ### Parameters #### Query Parameters - **type** (string) - Optional - Filter by alert type. ### Response #### Success Response (200) - (array of strings) - A list of available alert types. #### Response Example ```json ["over_speed", "geofence_breach"] ``` ``` -------------------------------- ### POST /dongle/devices/{id}/accept_key/ Source: https://api.autopi.io/index_format=openapi Approves a new device key for a dongle device. ```APIDOC ## POST /dongle/devices/{id}/accept_key/ ### Description Approves a new device key for a dongle device. ### Method POST ### Endpoint /dongle/devices/{id}/accept_key/ ### Parameters #### Path Parameters - **id** (string format: uuid) - Required - A UUID string identifying this device. ### Response #### Success Response (200) - **Device** (object) - Returns the updated device instance. #### Response Example ```json { "example": "device instance" } ``` ``` -------------------------------- ### POST /dongle/workers/ Source: https://api.autopi.io/index_format=openapi Creates a new dongle worker. Requires 'engine' and 'device' query parameters. ```APIDOC ## POST /dongle/workers/ ### Description Creates a new dongle worker. Requires 'engine' and 'device' query parameters. ### Method POST ### Endpoint /dongle/workers/ ### Parameters #### Query Parameters - **engine** (string) - Required - The engine for the worker. - **device** (string) - Required - The device for the worker. - **template** (string) - Optional - The template for the worker. #### Request Body - **WriteableMessageWorker** (object) - The worker configuration details. ### Request Example ```json { "command": "start_capture", "parameters": { "duration": 300 } } ``` ### Response #### Success Response (200) - **MessageWorker** (object) - The created worker details. #### Response Example ```json { "id": "worker-456", "status": "pending", "engine": "main" } ``` ``` -------------------------------- ### POST /dongle/{unit_id}/execute/ Source: https://api.autopi.io/index_format=openapi Executes a command on a specific dongle unit. ```APIDOC ## POST /dongle/{unit_id}/execute/ ### Description Executes a command on a specified dongle unit. ### Method POST ### Endpoint /dongle/{unit_id}/execute/ ### Parameters #### Path Parameters - **unit_id** (string) - Required - The unique identifier of the dongle unit. #### Request Body - **data** (ExecuteCommand) - Required - The command to execute. ### Response #### Success Response (200) - **(schema: #/definitions/ExecuteCommandResponse)** - The response from executing the command. #### Error Response (400) - **(schema: #/definitions/ExecuteCommandStatusResponse)** - The status response if the command fails. #### Response Example (Schema definition not provided in input) ``` -------------------------------- ### GET /can_logging/channels/ Source: https://api.autopi.io/index_format=openapi Retrieves a paginated list of CAN logging channels. ```APIDOC ## GET /can_logging/channels/ ### Description Retrieves a paginated list of CAN logging channels. ### Method GET ### Endpoint /can_logging/channels/ ### Parameters #### Query Parameters - **ordering** (string) - Optional - Which field to use when ordering the results. - **search** (string) - Optional - A search term. - **page** (integer) - Optional - Page number. - **page_size** (integer) - Optional - Number of items per page. ### Response #### Success Response (200) - **results** (array) - A list of CAN logging channels. - *See Channel schema for details* - **count** (integer) - The total number of items available. - **page_size** (integer) - The number of items per page. ```