# Losant Python REST API Client
 [](https://badge.fury.io/py/losant-rest)
The [Losant](https://www.losant.com) REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.
This client works with both Python 2.7 and 3. It uses [Requests](https://github.com/kennethreitz/requests/) under the covers for the actual HTTP communication.
<br/>
## Installation
The latest stable version is available in the Python Package Index (PyPi) and can be installed using
```bash
pip install losant-rest
```
<br/>
## Example
Below is a high-level example of using the Losant Python REST API client to authenticate against the Losant Platform and report state for a device.
```python
from platformrest import Client
from analog import AnalogSensor
client = Client()
creds = {
'deviceId': 'my-device-id',
'key': 'my-app-access-key',
'secret': 'my-app-access-secret'
}
response = client.auth.authenticate_device(credentials=creds)
client.auth_token = response['token']
app_id = response['applicationId']
state = {'data': {'temperature': AnalogSensor.read()}}
response = client.device.send_state(deviceId='my-device-id',
applicationId=app_id, deviceState=state)
print(response)
""" {'success': True} """
```
<br/>
## API Documentation
### Client
A client is a single api instance. By default, it is unauthenticated, but can be given an access token to perform authenticated requests.
#### Constructor
```python
Client(auth_token=None, url="https://api.losant.com")
```
The ``Client()`` constructor takes the following arguments:
* auth_token
The access token to be used for authentication - by default there is no access token. An access token can be acquired through any of the [Auth](docs/auth.md) methods, or can be created for a particular application through [application_api_tokens](docs/applicationApiTokens.md).
* url
The url of the Losant API - by default <https://api.losant.com>.
#### Properties
* auth_token
The access token can be accessed or changed after Client creation through this property.
* url
The api base url can be accessed or changed after Client creation through this property.
#### Resources
Each of the following is a property on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.
* [application](docs/application.md)
Contains all of the actions that can be performed against a single [Application](https://docs.losant.com/applications/overview/), which include things like getting info on an application or modifying an application.
* [application_api_token](docs/applicationApiToken.md)
Contains all the actions that can be performed against a single [Api Token](https://docs.losant.com/applications/application-tokens/) belonging to an application - for instance, getting info on a single token or revoking a token.
* [application_api_tokens](docs/applicationApiTokens.md)
Contains all of the actions that can be performed against the collection of [Api Tokens](https://docs.losant.com/applications/application-tokens/) belonging to an Application - such as listing all tokens or creating a new token.
* [application_certificate](docs/applicationCertificate.md)
Contains all the actions that can be performed against a single Application Certificate belonging to an application - for instance, getting info on a single certificate or disabling a certificate.
* [application_certificate_authorities](docs/applicationCertificateAuthorities.md)
Contains all the actions that can be performed against a single Application Certificate Authority belonging to an application - for instance, getting info on an authority or disabling an authority.
* [application_certificate_authority](docs/applicationCertificateAuthority.md)
Contains all of the actions that can be performed against the collection of Application Certificate Authorities belonging to an Application - such as listing all authorities or creating a new authority.
* [application_certificates](docs/applicationCertificates.md)
Contains all of the actions that can be performed against the collection of Application Certificates belonging to an Application - such as listing all certificates or creating a new certificate.
* [application_cashboard](docs/applicationDashboard.md)
Contains all the actions that can be performed against a single [Application Dashboard](https://docs.losant.com/dashboards/overview/) - for instance, things like getting info on a dashboard or modifying a dashboard.
* [application_dashboards](docs/applicationDashboards.md)
Contains all of the actions that can be performed against the collection of [Application Dashboards](https://docs.losant.com/dashboards/overview/) belonging to an Application - such as listing all dashboards or creating a new dashboard.
* [application_key](docs/applicationKey.md)
Contains all the actions that can be performed against a single [Application Key](https://docs.losant.com/applications/access-keys/) - for instance, getting info on a single key or revoking a key.
* [application_keys](docs/applicationKeys.md)
Contains all of the actions that can be performed against the collection of [Application Keys](https://docs.losant.com/applications/access-keys/) belonging to an Application - such as listing all keys or creating a new key.
* [applications](docs/applications.md)
Contains all of the actions that can be performed against the set of [Applications](https://docs.losant.com/applications/overview/) that the currently authenticated user has access to - such as listing the applications or creating a new application.
* [application_template](docs/applicationTemplate.md)
Contains all the actions that can be performed against a single [Application Template](https://docs.losant.com/templates/overview/) - for instance, getting info on a single template.
* [application_templates](docs/applicationTemplates.md)
Contains all of the actions that can be performed against the collection of [Application Templates](https://docs.losant.com/templates/overview/) - such as listing all templates or categories.
* [audit_log](docs/auditLog.md)
Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/organizations/audit-logs/) that belongs to an organization - such as viewing a log.
* [audit_logs](docs/auditLogs.md)
Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/organizations/audit-logs/) that belong to an organization - such as listing the logs.
* [auth](docs/auth.md)
Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.
* [credential](docs/credential.md)
Contains all the actions that can be performed against a single [Service Credential](https://docs.losant.com/applications/credentials/), such as updating a credential or removing a credential.
* [credentials](docs/credentials.md)
Contains all of the actions that can be performed against the set of [Service Credentials](https://docs.losant.com/applications/credentials/) that the currently authenticated user has access to - such as listing the credentials or creating a new credential.
* [dashboard](docs/dashboard.md)
Contains all of the actions that can be performed against a single [Dashboard](https://docs.losant.com/dashboards/overview/), which include things like getting info on a dashboard or modifying a dashboard.
* [dashboards](docs/dashboards.md)
Contains all of the actions that can be performed against the set of [Dashboards](https://docs.losant.com/dashboards/overview/) that the currently authenticated user has access to - such as listing the dashboards or creating a new dashboard.
* [data](docs/data.md)
Contains the actions for querying against historical Device data across an Application.
* [data_table](docs/dataTable.md)
Contains all the actions that can be performed against a single [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting info on a single data table or modifying the columns of a data table.
* [data_table_row](docs/dataTableRow.md)
Contains all the actions that can be performed against a single row inside of a [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting the contents of a row, or modifying a row.
* [data_table_rows](docs/dataTableRows.md)
Contains all of the actions that can be performed against the collection of rows that make up a [Data Table](https://docs.losant.com/data-tables/overview/) - such as querying for rows in that table, or adding a new row to the table.
* [data_tables](docs/dataTables.md)
Contains all of the actions that can be performed against the collection of [Data Tables](https://docs.losant.com/data-tables/overview/) belonging to an Application - such as listing all data tables or creating a new data table.
* [device](docs/device.md)
Contains all the actions that can be performed against a single [Device](https://docs.losant.com/devices/overview/) - for instance, getting info on a single device or reporting the current state of a device.
* [device_recipe](docs/deviceRecipe.md)
Contains all the actions that can be performed against a single [Device Recipe](https://docs.losant.com/devices/device-recipes/), which include things like removing a device recipe or creating a device from a device recipe.
* [device_recipes](docs/deviceRecipes.md)
Contains all the actions that can be performed against the collection of [Device Recipes](https://docs.losant.com/devices/device-recipes/) belonging to an Application - such as listing recipes or creating a new recipe.
* [devices](docs/devices.md)
Contains all of the actions that can be performed against the collection of [Devices](https://docs.losant.com/devices/overview/) belonging to an Application - such as listing all devices or sending a command to a set of devices.
* [edge_deployment](docs/edgeDeployment.md)
Contains all the actions that can be performed against a single [Edge Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.
* [edge_deployments](docs/edgeDeployments.md)
Contains all the actions that can be performed against the collection of [Edge Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.
* [embedded_deployment](docs/embeddedDeployment.md)
Contains all the actions that can be performed against a single [Embedded Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.
* [embedded_deployments](docs/embeddedDeployments.md)
Contains all the actions that can be performed against the collection of [Embedded Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.
* [event](docs/event.md)
Contains all the actions that can be performed against a single [Event](https://docs.losant.com/events/overview/), such as commenting on or changing the state of an event.
* [events](docs/events.md)
Contains all the actions that can be performed against the collection of [Events](https://docs.losant.com/events/overview/) belonging to an Application - such as listing open events or creating a new event.
* [experience](docs/experience.md)
Contains all the actions that can be performed against an application [Experience](https://docs.losant.com/experiences/), such as bootstrapping or clearing resources.
* [experience_domain](docs/experienceDomain.md)
Contains all the actions that can be performed against a single [Experience Domain](https://docs.losant.com/experiences/domains/), such as updating SSL certificate information.
* [experience_domains](docs/experienceDomains.md)
Contains all the actions that can be performed against the collection of [Experience Domains](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing domains or creating a new domain.
* [experience_endpoint](docs/experienceEndpoint.md)
Contains all the actions that can be performed against a single [Experience Endpoint](https://docs.losant.com/experiences/endpoints/), such as updating route information.
* [experience_endpoints](docs/experienceEndpoints.md)
Contains all the actions that can be performed against the collection of [Experience Endpoints](https://docs.losant.com/experiences/endpoints/) belonging to an Application - such as listing endpoints or creating a new endpoint.
* [experience_group](docs/experienceGroup.md)
Contains all the actions that can be performed against a single [Experience Group](https://docs.losant.com/experiences/groups/), such as updating member information.
* [experience_groups](docs/experienceGroups.md)
Contains all the actions that can be performed against the collection of [Experience Groups](https://docs.losant.com/experiences/groups/) belonging to an Application - such as listing groups or creating a new group.
* [experience_slug](docs/experienceSlug.md)
Contains all the actions that can be performed against a single [Experience Slug](https://docs.losant.com/experiences/domains/), such as changing the associated version.
* [experience_slugs](docs/experienceSlugs.md)
Contains all the actions that can be performed against the collection of [Experience Slugs](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing slugs or creating a new slug.
* [experience_user](docs/experienceUser.md)
Contains all the actions that can be performed against a single [Experience User](https://docs.losant.com/experiences/users/), such as changing their email or password.
* [experience_users](docs/experienceUsers.md)
Contains all the actions that can be performed against the collection of [Experience Users](https://docs.losant.com/experiences/users/) belonging to an Application - such as listing users or creating a new user.
* [experience_version](docs/experienceVersion.md)
Contains all the actions that can be performed against a single [Experience Version](https://docs.losant.com/experiences/), such as modifying the description.
* [experience_versions](docs/experienceVersions.md)
Contains all the actions that can be performed against the collection of [Experience Versions](https://docs.losant.com/experiences/) belonging to an Application - such as listing versions or creating a new versions.
* [experience_view](docs/experienceView.md)
Contains all the actions that can be performed against a single [Experience View](https://docs.losant.com/experiences/views/), such as modifying the body template.
* [experience_views](docs/experienceViews.md)
Contains all the actions that can be performed against the collection of [Experience Views](https://docs.losant.com/experiences/views/) belonging to an Application - such as listing views or creating a new view.
* [file](docs/file.md)
Contains all the actions that can be performed against a single [File](https://docs.losant.com/applications/files/), such as moving, renaming, or deleting.
* [files](docs/files.md)
Contains all the actions that can be performed against the collection of [Files](https://docs.losant.com/applications/files/) belonging to an Application - such as listing files or uploading a new file.
* [flow](docs/flow.md)
Contains all the actions that can be performed against a single [Workflow](https://docs.losant.com/workflows/overview/), such as enabling or disabling a workflow, or triggering a virtual button in the workflow.
* [flows](docs/flows.md)
Contains all the actions that can be performed against the collection of [Workflows](https://docs.losant.com/workflows/overview/) belonging to an Application - such as listing the workflows or creating a new workflow.
* [flow_version](docs/flowVersion.md)
Contains all the actions that can be performed against a single [Workflow Version](https://docs.losant.com/workflows/versioning/), such as enabling or disabling a workflow version, or updating the version notes.
* [flow_versions](docs/flowVersions.md)
Contains all the actions that can be performed against the collection of [Workflow Versions](https://docs.losant.com/workflows/versioning/) belonging to a Workflow - such as listing the versions or creating a new version.
* [instance](docs/instance.md)
Contains all the actions that can be performed against a single [Instance](https://docs.losant.com/instance-manager/overview/), which include things such as updating report configuration or defaults.
* [instance_api_token](docs/instanceApiToken.md)
Contains all the actions that can be performed against a single [Instance API Token](https://docs.losant.com/instance-manager/instance-tokens/) - for instance, getting info on a single token or revoking a token.
* [instance_api_tokens](docs/instanceApiTokens.md)
Contains all the actions that can be performed against the collection of [Instance API Tokens](https://docs.losant.com/instance-manager/instance-tokens/) belonging to an Instance - such as listing tokens or creating a new token.
* [instance_audit_log](docs/instanceAuditLog.md)
Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as viewing a log.
* [instance_audit_logs](docs/instanceAuditLogs.md)
Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as listing the logs.
* [instance_custom_node](docs/instanceCustomNode.md)
Contains all the actions that can be performed against a single [Instance Custom Node](https://docs.losant.com/instance-manager/instance-custom-nodes/) - for instance, getting info on a single custom node or modifying a custom node.
* [instance_custom_nodes](docs/instanceCustomNodes.md)
Contains all the actions that can be performed against the collection of [Instance Custom Nodes](https://docs.losant.com/instance-manager/instance-custom-nodes/) belonging to an Instance - such as listing custom nodes or creating a new custom node.
* [instance_member](docs/instanceMember.md)
Contains all the actions that can be performed against a single [Instance Member](https://docs.losant.com/instance-manager/overview/#managing-membership), which include things such as updating the role or removing the member.
* [instance_members](docs/instanceMembers.md)
Contains all the actions that can be performed against the collection of [Instance Members](https://docs.losant.com/instance-manager/overview/#managing-membership) belonging to an Instance - such as listing members or adding a new member.
* [instance_notification_rule](docs/instanceNotificationRule.md)
Contains all the actions that can be performed against a single [Instance Notification Rule](https://docs.losant.com/instance-manager/overview/#notifications), which include things such as updating the threshold or the targets.
* [instance_notification_rules](docs/instanceNotificationRules.md)
Contains all the actions that can be performed against the collection of [Instance Notification Rules](https://docs.losant.com/instance-manager/overview/#notifications) belonging to an Instance - such as listing rules or adding a new rule.
* [instance_org_invite](docs/instanceOrgInvite.md)
Contains all the actions that can be performed against a single [Instance Organization Invite](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations), which include things such as revoking the invite.
* [instance_org_invites](docs/instanceOrgInvites.md)
Contains all the actions that can be performed against the collection of [Instance Organization Invites](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations) belonging to an Organization in an Instance - such as listing invites or sending a new invitation.
* [instance_org_member](docs/instanceOrgMember.md)
Contains all the actions that can be performed against a single [Instance Organization Member](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership), which include things such as changing the role or removing the membership.
* [instance_org_members](docs/instanceOrgMembers.md)
Contains all the actions that can be performed against the collection of [Instance Organization Members](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership) belonging to an Organization in an Instance - such as listing members or adding new members.
* [instance_org](docs/instanceOrganization.md)
Contains all the actions that can be performed against a single [Instance Organization](https://docs.losant.com/instance-manager/managing-organizations/), which include things such as modifying limits.
* [instance_orgs](docs/instanceOrgs.md)
Contains all the actions that can be performed against the collection of [Instance Organizations](https://docs.losant.com/instance-manager/managing-organizations/) belonging to an Instance - such as listing organizations or adding a new organization.
* [instance_sandbox](docs/instanceSandbox.md)
Contains all the actions that can be performed against a single [Instance Sandbox](https://docs.losant.com/instance-manager/managing-sandbox-users/) - for instance, getting info on a single sandbox or deleting the sandbox.
* [instance_sandboxes](docs/instanceSandboxes.md)
Contains all the actions that can be performed against the collection of [Instance Sandboxes](https://docs.losant.com/instance-manager/managing-sandbox-users/) belonging to an Instance - such as listing sandboxes.
* [instances](docs/instances.md)
Contains all the actions that can be performed against the collection of [Instances](https://docs.losant.com/instance-manager/overview/) that the currently authenticated user has access to - such as listing instances.
* [integration](docs/integration.md)
Contains all the actions that can be performed against a single [Integration](https://docs.losant.com/applications/integrations/), which include things like removing an integration or updating integration configuration.
* [integrations](docs/integrations.md)
Contains all the actions that can be performed against the collection of [Integrations](https://docs.losant.com/applications/integrations/) belonging to an Application - such as listing integrations or creating a new integration.
* [me](docs/me.md)
Contains the actions for operating against the currently authenticated [User](https://docs.losant.com/user-accounts/overview/) such as changing the password or linking against external services.
* [notebook](docs/notebook.md)
Contains all the actions that can be performed against a single [Notebook](https://docs.losant.com/notebooks/overview/), which include things like removing a notebook or executing a notebook.
* [notebooks](docs/notebooks.md)
Contains all the actions that can be performed against the collection of [Notebooks](https://docs.losant.com/notebooks/overview/) belonging to an Application - such as listing notebooks or creating a new notebook.
* [org_invites](docs/orgInvites.md)
Contains all of the actions that can be performed against a invitation to an organization, such as accepting the invitation.
* [org](docs/org.md)
Contains all the actions that can be performed against a single [Organization](https://docs.losant.com/organizations/overview/), things like inviting a user to the organization, or modifying the organization.
* [orgs](docs/orgs.md)
Contains all of the actions that can be performed against the set of [Organizations](https://docs.losant.com/organizations/overview/) that the currently authenticated user has access to - such as listing the organizations or creating a new organization.
* [resource_job](docs/resourceJob.md)
Contains all the actions that can be performed against a single [Resource Job](https://docs.losant.com/applications/resource-jobs/), such as executing the job.
* [resource_jobs](docs/resourceJobs.md)
Contains all the actions that can be performed against the collection of [Resource Jobs](https://docs.losant.com/applications/resource-jobs/) belonging to an Application - such as listing resource jobs or creating a new resource job.
* [user_api_token](docs/userApiToken.md)
Contains all the actions that can be performed against a single [User API Token](https://docs.losant.com/user-accounts/user-tokens/), such as revoking the token.
* [user_api_tokens](docs/userApiTokens.md)
Contains all the actions that can be performed against the collection of [User API Tokens](https://docs.losant.com/user-accounts/user-tokens/) belonging to the currently authenticated user - such as listing tokens or creating a new token.
* [webhook](docs/webhook.md)
Contains all the actions that can be performed against a single [Webhook](https://docs.losant.com/applications/webhooks/), for instance modifying the verification settings or removing the webhook.
* [webhooks](docs/webhooks.md)
Contains all the actions that can be performed against the collection of [Webhooks](https://docs.losant.com/applications/webhooks/) belonging to an Application - such as listing the webhooks or creating a new webhook.
<br/>
*****
Copyright (c) 2024 Losant IoT, Inc
<https://www.losant.com>
Raw data
{
"_id": null,
"home_page": "https://github.com/Losant/losant-rest-python",
"name": "losant-rest",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "REST, Losant, IoT",
"author": "Losant",
"author_email": "hello@losant.com",
"download_url": "https://files.pythonhosted.org/packages/a2/44/cea8d5d9356ec829edb755596e154115ba76f1eb892f3b8462660e486ab0/losant-rest-1.21.1.tar.gz",
"platform": null,
"description": "# Losant Python REST API Client\n\n [](https://badge.fury.io/py/losant-rest)\n\nThe [Losant](https://www.losant.com) REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.\n\nThis client works with both Python 2.7 and 3. It uses [Requests](https://github.com/kennethreitz/requests/) under the covers for the actual HTTP communication.\n\n<br/>\n\n## Installation\n\nThe latest stable version is available in the Python Package Index (PyPi) and can be installed using\n\n```bash\npip install losant-rest\n```\n\n<br/>\n\n## Example\n\nBelow is a high-level example of using the Losant Python REST API client to authenticate against the Losant Platform and report state for a device.\n\n```python\nfrom platformrest import Client\nfrom analog import AnalogSensor\n\nclient = Client()\ncreds = {\n 'deviceId': 'my-device-id',\n 'key': 'my-app-access-key',\n 'secret': 'my-app-access-secret'\n}\nresponse = client.auth.authenticate_device(credentials=creds)\n\nclient.auth_token = response['token']\napp_id = response['applicationId']\n\nstate = {'data': {'temperature': AnalogSensor.read()}}\nresponse = client.device.send_state(deviceId='my-device-id',\n applicationId=app_id, deviceState=state)\n\nprint(response)\n\"\"\" {'success': True} \"\"\"\n```\n\n<br/>\n\n## API Documentation\n\n### Client\n\nA client is a single api instance. By default, it is unauthenticated, but can be given an access token to perform authenticated requests.\n\n#### Constructor\n\n```python\nClient(auth_token=None, url=\"https://api.losant.com\")\n```\n\nThe ``Client()`` constructor takes the following arguments:\n\n* auth_token \n The access token to be used for authentication - by default there is no access token. An access token can be acquired through any of the [Auth](docs/auth.md) methods, or can be created for a particular application through [application_api_tokens](docs/applicationApiTokens.md).\n\n* url \n The url of the Losant API - by default <https://api.losant.com>.\n\n#### Properties\n\n* auth_token \n The access token can be accessed or changed after Client creation through this property.\n\n* url \n The api base url can be accessed or changed after Client creation through this property.\n\n#### Resources\n\nEach of the following is a property on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.\n\n* [application](docs/application.md) \n Contains all of the actions that can be performed against a single [Application](https://docs.losant.com/applications/overview/), which include things like getting info on an application or modifying an application.\n\n* [application_api_token](docs/applicationApiToken.md) \n Contains all the actions that can be performed against a single [Api Token](https://docs.losant.com/applications/application-tokens/) belonging to an application - for instance, getting info on a single token or revoking a token.\n\n* [application_api_tokens](docs/applicationApiTokens.md) \n Contains all of the actions that can be performed against the collection of [Api Tokens](https://docs.losant.com/applications/application-tokens/) belonging to an Application - such as listing all tokens or creating a new token.\n\n* [application_certificate](docs/applicationCertificate.md) \n Contains all the actions that can be performed against a single Application Certificate belonging to an application - for instance, getting info on a single certificate or disabling a certificate.\n\n* [application_certificate_authorities](docs/applicationCertificateAuthorities.md) \n Contains all the actions that can be performed against a single Application Certificate Authority belonging to an application - for instance, getting info on an authority or disabling an authority.\n\n* [application_certificate_authority](docs/applicationCertificateAuthority.md) \n Contains all of the actions that can be performed against the collection of Application Certificate Authorities belonging to an Application - such as listing all authorities or creating a new authority.\n\n* [application_certificates](docs/applicationCertificates.md) \n Contains all of the actions that can be performed against the collection of Application Certificates belonging to an Application - such as listing all certificates or creating a new certificate.\n\n* [application_cashboard](docs/applicationDashboard.md) \n Contains all the actions that can be performed against a single [Application Dashboard](https://docs.losant.com/dashboards/overview/) - for instance, things like getting info on a dashboard or modifying a dashboard.\n\n* [application_dashboards](docs/applicationDashboards.md) \n Contains all of the actions that can be performed against the collection of [Application Dashboards](https://docs.losant.com/dashboards/overview/) belonging to an Application - such as listing all dashboards or creating a new dashboard.\n\n* [application_key](docs/applicationKey.md) \n Contains all the actions that can be performed against a single [Application Key](https://docs.losant.com/applications/access-keys/) - for instance, getting info on a single key or revoking a key.\n\n* [application_keys](docs/applicationKeys.md) \n Contains all of the actions that can be performed against the collection of [Application Keys](https://docs.losant.com/applications/access-keys/) belonging to an Application - such as listing all keys or creating a new key.\n\n* [applications](docs/applications.md) \n Contains all of the actions that can be performed against the set of [Applications](https://docs.losant.com/applications/overview/) that the currently authenticated user has access to - such as listing the applications or creating a new application.\n\n* [application_template](docs/applicationTemplate.md) \n Contains all the actions that can be performed against a single [Application Template](https://docs.losant.com/templates/overview/) - for instance, getting info on a single template.\n\n* [application_templates](docs/applicationTemplates.md) \n Contains all of the actions that can be performed against the collection of [Application Templates](https://docs.losant.com/templates/overview/) - such as listing all templates or categories.\n\n* [audit_log](docs/auditLog.md) \n Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/organizations/audit-logs/) that belongs to an organization - such as viewing a log.\n\n* [audit_logs](docs/auditLogs.md) \n Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/organizations/audit-logs/) that belong to an organization - such as listing the logs.\n\n* [auth](docs/auth.md) \n Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.\n\n* [credential](docs/credential.md) \n Contains all the actions that can be performed against a single [Service Credential](https://docs.losant.com/applications/credentials/), such as updating a credential or removing a credential.\n\n* [credentials](docs/credentials.md) \n Contains all of the actions that can be performed against the set of [Service Credentials](https://docs.losant.com/applications/credentials/) that the currently authenticated user has access to - such as listing the credentials or creating a new credential.\n\n* [dashboard](docs/dashboard.md) \n Contains all of the actions that can be performed against a single [Dashboard](https://docs.losant.com/dashboards/overview/), which include things like getting info on a dashboard or modifying a dashboard.\n\n* [dashboards](docs/dashboards.md) \n Contains all of the actions that can be performed against the set of [Dashboards](https://docs.losant.com/dashboards/overview/) that the currently authenticated user has access to - such as listing the dashboards or creating a new dashboard.\n\n* [data](docs/data.md) \n Contains the actions for querying against historical Device data across an Application.\n\n* [data_table](docs/dataTable.md) \n Contains all the actions that can be performed against a single [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting info on a single data table or modifying the columns of a data table.\n\n* [data_table_row](docs/dataTableRow.md) \n Contains all the actions that can be performed against a single row inside of a [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting the contents of a row, or modifying a row.\n\n* [data_table_rows](docs/dataTableRows.md) \n Contains all of the actions that can be performed against the collection of rows that make up a [Data Table](https://docs.losant.com/data-tables/overview/) - such as querying for rows in that table, or adding a new row to the table.\n\n* [data_tables](docs/dataTables.md) \n Contains all of the actions that can be performed against the collection of [Data Tables](https://docs.losant.com/data-tables/overview/) belonging to an Application - such as listing all data tables or creating a new data table.\n\n* [device](docs/device.md) \n Contains all the actions that can be performed against a single [Device](https://docs.losant.com/devices/overview/) - for instance, getting info on a single device or reporting the current state of a device.\n\n* [device_recipe](docs/deviceRecipe.md) \n Contains all the actions that can be performed against a single [Device Recipe](https://docs.losant.com/devices/device-recipes/), which include things like removing a device recipe or creating a device from a device recipe.\n\n* [device_recipes](docs/deviceRecipes.md) \n Contains all the actions that can be performed against the collection of [Device Recipes](https://docs.losant.com/devices/device-recipes/) belonging to an Application - such as listing recipes or creating a new recipe.\n\n* [devices](docs/devices.md) \n Contains all of the actions that can be performed against the collection of [Devices](https://docs.losant.com/devices/overview/) belonging to an Application - such as listing all devices or sending a command to a set of devices.\n\n* [edge_deployment](docs/edgeDeployment.md) \n Contains all the actions that can be performed against a single [Edge Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.\n\n* [edge_deployments](docs/edgeDeployments.md) \n Contains all the actions that can be performed against the collection of [Edge Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.\n\n* [embedded_deployment](docs/embeddedDeployment.md) \n Contains all the actions that can be performed against a single [Embedded Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.\n\n* [embedded_deployments](docs/embeddedDeployments.md) \n Contains all the actions that can be performed against the collection of [Embedded Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.\n\n* [event](docs/event.md) \n Contains all the actions that can be performed against a single [Event](https://docs.losant.com/events/overview/), such as commenting on or changing the state of an event.\n\n* [events](docs/events.md) \n Contains all the actions that can be performed against the collection of [Events](https://docs.losant.com/events/overview/) belonging to an Application - such as listing open events or creating a new event.\n\n* [experience](docs/experience.md) \n Contains all the actions that can be performed against an application [Experience](https://docs.losant.com/experiences/), such as bootstrapping or clearing resources.\n\n* [experience_domain](docs/experienceDomain.md) \n Contains all the actions that can be performed against a single [Experience Domain](https://docs.losant.com/experiences/domains/), such as updating SSL certificate information.\n\n* [experience_domains](docs/experienceDomains.md) \n Contains all the actions that can be performed against the collection of [Experience Domains](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing domains or creating a new domain.\n\n* [experience_endpoint](docs/experienceEndpoint.md) \n Contains all the actions that can be performed against a single [Experience Endpoint](https://docs.losant.com/experiences/endpoints/), such as updating route information.\n\n* [experience_endpoints](docs/experienceEndpoints.md) \n Contains all the actions that can be performed against the collection of [Experience Endpoints](https://docs.losant.com/experiences/endpoints/) belonging to an Application - such as listing endpoints or creating a new endpoint.\n\n* [experience_group](docs/experienceGroup.md) \n Contains all the actions that can be performed against a single [Experience Group](https://docs.losant.com/experiences/groups/), such as updating member information.\n\n* [experience_groups](docs/experienceGroups.md) \n Contains all the actions that can be performed against the collection of [Experience Groups](https://docs.losant.com/experiences/groups/) belonging to an Application - such as listing groups or creating a new group.\n\n* [experience_slug](docs/experienceSlug.md) \n Contains all the actions that can be performed against a single [Experience Slug](https://docs.losant.com/experiences/domains/), such as changing the associated version.\n\n* [experience_slugs](docs/experienceSlugs.md) \n Contains all the actions that can be performed against the collection of [Experience Slugs](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing slugs or creating a new slug.\n\n* [experience_user](docs/experienceUser.md) \n Contains all the actions that can be performed against a single [Experience User](https://docs.losant.com/experiences/users/), such as changing their email or password.\n\n* [experience_users](docs/experienceUsers.md) \n Contains all the actions that can be performed against the collection of [Experience Users](https://docs.losant.com/experiences/users/) belonging to an Application - such as listing users or creating a new user.\n\n* [experience_version](docs/experienceVersion.md) \n Contains all the actions that can be performed against a single [Experience Version](https://docs.losant.com/experiences/), such as modifying the description.\n\n* [experience_versions](docs/experienceVersions.md) \n Contains all the actions that can be performed against the collection of [Experience Versions](https://docs.losant.com/experiences/) belonging to an Application - such as listing versions or creating a new versions.\n\n* [experience_view](docs/experienceView.md) \n Contains all the actions that can be performed against a single [Experience View](https://docs.losant.com/experiences/views/), such as modifying the body template.\n\n* [experience_views](docs/experienceViews.md) \n Contains all the actions that can be performed against the collection of [Experience Views](https://docs.losant.com/experiences/views/) belonging to an Application - such as listing views or creating a new view.\n\n* [file](docs/file.md) \n Contains all the actions that can be performed against a single [File](https://docs.losant.com/applications/files/), such as moving, renaming, or deleting.\n\n* [files](docs/files.md) \n Contains all the actions that can be performed against the collection of [Files](https://docs.losant.com/applications/files/) belonging to an Application - such as listing files or uploading a new file.\n\n* [flow](docs/flow.md) \n Contains all the actions that can be performed against a single [Workflow](https://docs.losant.com/workflows/overview/), such as enabling or disabling a workflow, or triggering a virtual button in the workflow.\n\n* [flows](docs/flows.md) \n Contains all the actions that can be performed against the collection of [Workflows](https://docs.losant.com/workflows/overview/) belonging to an Application - such as listing the workflows or creating a new workflow.\n\n* [flow_version](docs/flowVersion.md) \n Contains all the actions that can be performed against a single [Workflow Version](https://docs.losant.com/workflows/versioning/), such as enabling or disabling a workflow version, or updating the version notes.\n\n* [flow_versions](docs/flowVersions.md) \n Contains all the actions that can be performed against the collection of [Workflow Versions](https://docs.losant.com/workflows/versioning/) belonging to a Workflow - such as listing the versions or creating a new version.\n\n* [instance](docs/instance.md) \n Contains all the actions that can be performed against a single [Instance](https://docs.losant.com/instance-manager/overview/), which include things such as updating report configuration or defaults.\n\n* [instance_api_token](docs/instanceApiToken.md) \n Contains all the actions that can be performed against a single [Instance API Token](https://docs.losant.com/instance-manager/instance-tokens/) - for instance, getting info on a single token or revoking a token.\n\n* [instance_api_tokens](docs/instanceApiTokens.md) \n Contains all the actions that can be performed against the collection of [Instance API Tokens](https://docs.losant.com/instance-manager/instance-tokens/) belonging to an Instance - such as listing tokens or creating a new token.\n\n* [instance_audit_log](docs/instanceAuditLog.md) \n Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as viewing a log.\n\n* [instance_audit_logs](docs/instanceAuditLogs.md) \n Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as listing the logs.\n\n* [instance_custom_node](docs/instanceCustomNode.md) \n Contains all the actions that can be performed against a single [Instance Custom Node](https://docs.losant.com/instance-manager/instance-custom-nodes/) - for instance, getting info on a single custom node or modifying a custom node.\n\n* [instance_custom_nodes](docs/instanceCustomNodes.md) \n Contains all the actions that can be performed against the collection of [Instance Custom Nodes](https://docs.losant.com/instance-manager/instance-custom-nodes/) belonging to an Instance - such as listing custom nodes or creating a new custom node.\n\n* [instance_member](docs/instanceMember.md) \n Contains all the actions that can be performed against a single [Instance Member](https://docs.losant.com/instance-manager/overview/#managing-membership), which include things such as updating the role or removing the member.\n\n* [instance_members](docs/instanceMembers.md) \n Contains all the actions that can be performed against the collection of [Instance Members](https://docs.losant.com/instance-manager/overview/#managing-membership) belonging to an Instance - such as listing members or adding a new member.\n\n* [instance_notification_rule](docs/instanceNotificationRule.md) \n Contains all the actions that can be performed against a single [Instance Notification Rule](https://docs.losant.com/instance-manager/overview/#notifications), which include things such as updating the threshold or the targets.\n\n* [instance_notification_rules](docs/instanceNotificationRules.md) \n Contains all the actions that can be performed against the collection of [Instance Notification Rules](https://docs.losant.com/instance-manager/overview/#notifications) belonging to an Instance - such as listing rules or adding a new rule.\n\n* [instance_org_invite](docs/instanceOrgInvite.md) \n Contains all the actions that can be performed against a single [Instance Organization Invite](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations), which include things such as revoking the invite.\n\n* [instance_org_invites](docs/instanceOrgInvites.md) \n Contains all the actions that can be performed against the collection of [Instance Organization Invites](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations) belonging to an Organization in an Instance - such as listing invites or sending a new invitation.\n\n* [instance_org_member](docs/instanceOrgMember.md) \n Contains all the actions that can be performed against a single [Instance Organization Member](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership), which include things such as changing the role or removing the membership.\n\n* [instance_org_members](docs/instanceOrgMembers.md) \n Contains all the actions that can be performed against the collection of [Instance Organization Members](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership) belonging to an Organization in an Instance - such as listing members or adding new members.\n\n* [instance_org](docs/instanceOrganization.md) \n Contains all the actions that can be performed against a single [Instance Organization](https://docs.losant.com/instance-manager/managing-organizations/), which include things such as modifying limits.\n\n* [instance_orgs](docs/instanceOrgs.md) \n Contains all the actions that can be performed against the collection of [Instance Organizations](https://docs.losant.com/instance-manager/managing-organizations/) belonging to an Instance - such as listing organizations or adding a new organization.\n\n* [instance_sandbox](docs/instanceSandbox.md) \n Contains all the actions that can be performed against a single [Instance Sandbox](https://docs.losant.com/instance-manager/managing-sandbox-users/) - for instance, getting info on a single sandbox or deleting the sandbox.\n\n* [instance_sandboxes](docs/instanceSandboxes.md) \n Contains all the actions that can be performed against the collection of [Instance Sandboxes](https://docs.losant.com/instance-manager/managing-sandbox-users/) belonging to an Instance - such as listing sandboxes.\n\n* [instances](docs/instances.md) \n Contains all the actions that can be performed against the collection of [Instances](https://docs.losant.com/instance-manager/overview/) that the currently authenticated user has access to - such as listing instances.\n\n* [integration](docs/integration.md) \n Contains all the actions that can be performed against a single [Integration](https://docs.losant.com/applications/integrations/), which include things like removing an integration or updating integration configuration.\n\n* [integrations](docs/integrations.md) \n Contains all the actions that can be performed against the collection of [Integrations](https://docs.losant.com/applications/integrations/) belonging to an Application - such as listing integrations or creating a new integration.\n\n* [me](docs/me.md) \n Contains the actions for operating against the currently authenticated [User](https://docs.losant.com/user-accounts/overview/) such as changing the password or linking against external services.\n\n* [notebook](docs/notebook.md) \n Contains all the actions that can be performed against a single [Notebook](https://docs.losant.com/notebooks/overview/), which include things like removing a notebook or executing a notebook.\n\n* [notebooks](docs/notebooks.md) \n Contains all the actions that can be performed against the collection of [Notebooks](https://docs.losant.com/notebooks/overview/) belonging to an Application - such as listing notebooks or creating a new notebook.\n\n* [org_invites](docs/orgInvites.md) \n Contains all of the actions that can be performed against a invitation to an organization, such as accepting the invitation.\n\n* [org](docs/org.md) \n Contains all the actions that can be performed against a single [Organization](https://docs.losant.com/organizations/overview/), things like inviting a user to the organization, or modifying the organization.\n\n* [orgs](docs/orgs.md) \n Contains all of the actions that can be performed against the set of [Organizations](https://docs.losant.com/organizations/overview/) that the currently authenticated user has access to - such as listing the organizations or creating a new organization.\n\n* [resource_job](docs/resourceJob.md) \n Contains all the actions that can be performed against a single [Resource Job](https://docs.losant.com/applications/resource-jobs/), such as executing the job.\n\n* [resource_jobs](docs/resourceJobs.md) \n Contains all the actions that can be performed against the collection of [Resource Jobs](https://docs.losant.com/applications/resource-jobs/) belonging to an Application - such as listing resource jobs or creating a new resource job.\n\n* [user_api_token](docs/userApiToken.md) \n Contains all the actions that can be performed against a single [User API Token](https://docs.losant.com/user-accounts/user-tokens/), such as revoking the token.\n\n* [user_api_tokens](docs/userApiTokens.md) \n Contains all the actions that can be performed against the collection of [User API Tokens](https://docs.losant.com/user-accounts/user-tokens/) belonging to the currently authenticated user - such as listing tokens or creating a new token.\n\n* [webhook](docs/webhook.md) \n Contains all the actions that can be performed against a single [Webhook](https://docs.losant.com/applications/webhooks/), for instance modifying the verification settings or removing the webhook.\n\n* [webhooks](docs/webhooks.md) \n Contains all the actions that can be performed against the collection of [Webhooks](https://docs.losant.com/applications/webhooks/) belonging to an Application - such as listing the webhooks or creating a new webhook.\n\n<br/>\n\n*****\n\nCopyright (c) 2024 Losant IoT, Inc\n\n<https://www.losant.com>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A REST client for the Losant API",
"version": "1.21.1",
"project_urls": {
"Homepage": "https://github.com/Losant/losant-rest-python"
},
"split_keywords": [
"rest",
" losant",
" iot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05df8f4c8a54e4d1ba7f7f8418092b284d0ad89f883cdf8507619a288c5744c3",
"md5": "081e76e6b7ab4026ba86bb5c99945333",
"sha256": "fb66610aadee08403762ef97b1d36eabfcb00ee3367a0404f4a4ff8b6a94a59a"
},
"downloads": -1,
"filename": "losant_rest-1.21.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "081e76e6b7ab4026ba86bb5c99945333",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 392605,
"upload_time": "2024-12-17T17:51:33",
"upload_time_iso_8601": "2024-12-17T17:51:33.376074Z",
"url": "https://files.pythonhosted.org/packages/05/df/8f4c8a54e4d1ba7f7f8418092b284d0ad89f883cdf8507619a288c5744c3/losant_rest-1.21.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a244cea8d5d9356ec829edb755596e154115ba76f1eb892f3b8462660e486ab0",
"md5": "072f7122c78e9ba3f4da6c209d407ae1",
"sha256": "ed9a3387a7d323e4e551e3e5a01a1c29e2198c1746f0c3c0e046eb867b878922"
},
"downloads": -1,
"filename": "losant-rest-1.21.1.tar.gz",
"has_sig": false,
"md5_digest": "072f7122c78e9ba3f4da6c209d407ae1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58356,
"upload_time": "2024-12-17T17:51:36",
"upload_time_iso_8601": "2024-12-17T17:51:36.377893Z",
"url": "https://files.pythonhosted.org/packages/a2/44/cea8d5d9356ec829edb755596e154115ba76f1eb892f3b8462660e486ab0/losant-rest-1.21.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 17:51:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Losant",
"github_project": "losant-rest-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "losant-rest"
}
JSON
