Mycodo API (1.0)

Download OpenAPI specification:Download

A REST API for Mycodo

cameras

Camera operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the camera

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id required	string The unique ID of the camera
img_type required	string The type of image to return, either "still" or "timelapse"

Responses

choices

Form choice operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

controllers

Controller operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the controller.

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the controller.

Responses

daemon

Daemon operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

dependency

Dependency operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

device_name

required

string

The device name to install dependencies for.

Responses

export_import

Export/Import operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

functions

Function operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the function

Responses

inputs

Input operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the input

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the input.

Responses

log

Log operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

log_type required	string Log to return the last lines of. Options: login, http_access, http_error, daemon, dependency, import, keepup, backup, restore, upgrade.
last_lines required	integer How many lines to return.

Responses

measurements

Measurement operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id required	string The unique ID of the device
unit required	string The unit of the measurement
channel required	integer The channel of the measurement
value required	string the value of the measurement

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id required	string The unique ID of the device
unit required	string The unit of the measurement
channel required	integer The channel of the measurement
epoch_start required	integer The start time, as epoch. Set to 0 for none.
epoch_end required	integer The end time, as epoch. Set to 0 for none.

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id required	string The unique ID of the device
unit required	string The unit of the measurement
channel required	integer The channel of the measurement
past_seconds required	integer How many seconds in the past to query.

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id required	string The unique ID of the device
unit required	string The unit of the measurement
channel required	integer The channel of the measurement
past_seconds required	integer How many seconds in the past to query.

Responses

notes

Note operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

outputs

Output operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the output.

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the output.

Responses

pids

PID operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the pid

Responses

settings

Settings operations

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

device_id

required

string

The unique ID of the controller (Input, etc.) for which the measurement belongs.

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the measurement

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the input

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the measurement

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the output

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the pid

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the trigger

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the unit

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

Responses

partial(func, *args, **keywords) - new function with partial application

of the given arguments and keywords.

Authorizations:

apikey

path Parameters

unique_id

required

string

The unique ID of the user