Skip to main content

Mender SDK for python

Project description

# Mender

## Usage

```py
mender = Mender(base_url = 'https://docker.mender.io/api/management/v1')

# List devices on page 1
devices = await mender.get_devices_paged(page=1)
print(devices)

# List all devices
async for device in mender.get_devices():
print(device)

# Filter all devices by attributes
async for device in mender.get_devices(attributes={"hostname": 'xxx-ffffffffffff'}):
print(device)
```

## Device inventory

`/inventory`

### API Endpoints

All URIs are relative to *https://docker.mender.io/api/management/v1/inventory*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Mender* | **devices_get** | **GET** /devices | List devices
*Mender* | **devices_id_delete** | **DELETE** /devices/{id} | Remove selected device
*Mender* | **devices_id_get** | **GET** /devices/{id} | Get a selected device
*Mender* | **devices_id_group_get** | **GET** /devices/{id}/group | Get a selected device's group
*Mender* | **devices_id_group_name_delete** | **DELETE** /devices/{id}/group/{name} | Remove a device from a group
*Mender* | **devices_id_group_put** | **PUT** /devices/{id}/group | Add a device to a group
*Mender* | **groups_get** | **GET** /groups | List groups
*Mender* | **groups_name_devices_get** | **GET** /groups/{name}/devices | List the devices belonging to a given group

## User administration and authentication

`/useradm`

### API Endpoints

All URIs are relative to *https://docker.mender.io/api/management/v1/useradm*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Mender* | **auth_login_post** | **POST** /auth/login | Log in to Mender
*Mender* | **settings_get** | **GET** /settings | Get user settings
*Mender* | **settings_post** | **POST** /settings | Set user settings
*Mender* | **users_get** | **GET** /users | List users
*Mender* | **users_id_delete** | **DELETE** /users/{id} | Remove user from the system
*Mender* | **users_id_get** | **GET** /users/{id} | Get user information
*Mender* | **users_id_put** | **PUT** /users/{id} | Update user information
*Mender* | **users_post** | **POST** /users | Create user

## References

* https://github.com/yongjhih/mender.js
* https://github.com/yongjhih/openapi-generator/tree/mender/modules/openapi-generator/src/main/resources/python-typing-client


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mender-0.0.1.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

mender-0.0.1-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page