flywheel.api.devices_api
DevicesApi
Bases: object
create_device(body, **kwargs)
Create a new device.
Will create a new device record together with an api key. Request must be an admin request. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | DeviceCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_device_with_http_info(body, **kwargs)
Create a new device.
Will create a new device record together with an api key. Request must be an admin request. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | DeviceCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_device(device_id, **kwargs)
Delete a device
Delete a device This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_device_key(device_id, key_id, **kwargs)
Delete Device Key
Delete a device API key. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
key_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_device_key_with_http_info(device_id, key_id, **kwargs)
Delete Device Key
Delete a device API key. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
key_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_device_with_http_info(device_id, **kwargs)
Delete a device
Delete a device This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
generate_key(device_id, **kwargs)
Generate device API key
Regenerate device API key This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
body | (ApiKeyInputWithOptionalLabel, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
generate_key_with_http_info(device_id, **kwargs)
Generate device API key
Regenerate device API key This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
body | (ApiKeyInputWithOptionalLabel, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_devices(**kwargs)
List all devices.
Requires login. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
join_keys | (bool, optional) | Return device key. Admins only, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_devices_status(**kwargs)
Get status for all known devices.
ok - missing - error - unknown This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_devices_status_with_http_info(**kwargs)
Get status for all known devices.
ok - missing - error - unknown This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_devices_with_http_info(**kwargs)
List all devices.
Requires login. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
join_keys | (bool, optional) | Return device key. Admins only, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_device(**kwargs)
Get current device.
Get current device. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_device_with_http_info(**kwargs)
Get current device.
Get current device. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_device(device_id, **kwargs)
Get device details
Get device details. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_device_with_http_info(device_id, **kwargs)
Get device details
Get device details. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_device(device_id, body, **kwargs)
Update a device
Update a device This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
body | DeviceAdminUpdate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_device_with_http_info(device_id, body, **kwargs)
Update a device
Update a device This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
device_id | str | | required |
body | DeviceAdminUpdate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
update_device(body, **kwargs)
Modify a device's type, name, interval, info or set errors.
Will modify the device record of the device making the request. Type may only be set once if not already specified at creation. Request must be a drone request. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | DeviceSelfUpdate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
update_device_with_http_info(body, **kwargs)
Modify a device's type, name, interval, info or set errors.
Will modify the device record of the device making the request. Type may only be set once if not already specified at creation. Request must be a drone request. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | DeviceSelfUpdate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |