Skip to main content

An API Client to use Cradlepoint RESTful API.

Project description

CradlepointAPIClient

NetCloud API


PyPI - Status PyPI - Format GitHub GitHub release (latest by date) PyPI - Python Version

An API Client for Cradlepoint to be able to easily use the API in a more standard way.

How to install

$ pip install CradlepointAPIClient

Usage

the argument "method" must be specify every time.

Default arguments and attributes

import CradlepointAPIClient

client = CradlepointAPIClient.Client(api_version='v2', verify=True)

client.get(method='', data=None)

# client.headers
# client.url_base

The first query

import CradlepointAPIClient
import json

client = CradlepointAPIClient.Client(api_version='v2', verify=True)
client.connect(x_cp_api_id='', x_cp_api_key='', x_ecm_api_id='', x_ecm_api_key='')

response = client.get(method='/groups')
print(json.dumps(response.json(), indent=4))

client.disconnect()

Paging

import CradlepointAPIClient
import json

client = CradlepointAPIClient.Client(api_version='v2', verify=True)
client.connect(x_cp_api_id='', x_cp_api_key='', x_ecm_api_id='', x_ecm_api_key='')

response = client.get(method='/groups', offset=0, limit=1)
print(json.dumps(response.json(), indent=4))

client.disconnect()

Fields

import CradlepointAPIClient
import json

client = CradlepointAPIClient.Client(api_version='v2', verify=True)
client.connect(x_cp_api_id='', x_cp_api_key='', x_ecm_api_id='', x_ecm_api_key='')

response = client.get(method='/groups', offset=0, limit=1, fields='id,name')
print(json.dumps(response.json(), indent=4))

client.disconnect()

Filtering

import CradlepointAPIClient
import json

client = CradlepointAPIClient.Client(api_version='v2', verify=True)
client.connect(x_cp_api_id='', x_cp_api_key='', x_ecm_api_id='', x_ecm_api_key='')

response = client.get(method='/groups', offset=0, limit=1, fields='id,name', name='test_group')
print(json.dumps(response.json(), indent=4))

client.disconnect()

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

CradlepointAPIClient-0.0.1.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

CradlepointAPIClient-0.0.1-py3-none-any.whl (4.8 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